Upload instances metadata to CAS
Uploads resulting metadata for instances to CAS. The level query parameter indicates the level or degree of complexity of the metadata to return in the response. Each of the levels provides the returned metadata in different tabular structures. Note that because this endpoint processes several kinds of operations, the application/json Content-Type header is not supported.
The properties that can be used as filter and sort criteria are:
- id,
- name,
- label,
- description,
- type,
- createdBy,
- creationTimeStamp,
- modifiedBy,
- modifiedTimeStamp,
- definition,
- resourceId,
- endpoint1Id, and
- endpoint2Id
1{2 "level": "dataDictionary",3 "prefix": "catalog",4 "dateTimeStampSuffix": true,5 "serverName": "cas-shared-default",6 "caslibName": "Public",7 "links": [8 {9 "method": "GET",10 "rel": "self",11 "href": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~Public/tables/DMDICTIONARY_2023-09-05T000000Z",12 "uri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~Public/tables/DMDICTIONARY_2023-09-05T000000Z",13 "type": "application/vnd.sas.data.table"14 }15 ]16}
| Name | Type | Required | Description |
|---|---|---|---|
filter | string<filter-criteria> | false | Filter criteria for returned objects. See Filtering in REST APIs. |
limit | integer | false | Maximum number of objects to return. Defaults to 10. |
sortBy | string<sort-criteria> | false | Sort returned objects. See Sorting in REST APIs. |
start | integer | false | 0-based Offset of first object to return. Defaults to 0. |
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type | string | true | The representation in the request body. Allowed value: application/vnd.sas.metadata.instance.upload.request+json |
Accept | string | false | The desired representation for the response. The default is application/vnd.sas.metadata.instance.upload.request+json. Allowed value: application/vnd.sas.metadata.instance.upload.request+json Default: application/vnd.sas.metadata.instance.upload.request+json |
A request to export metadata and upload to CAS. Options are available to specify the type and format of the metadata.
| Name | Type | Required | Description |
|---|---|---|---|
version | integer | false | The version of the media type. |
level | string<enumeration> | false | The level or degree of complexity of metadata to be included. Allowed values: dataDictionarydataDictionaryAndProfiledetailedMetrics Default: dataDictionary |
prefix | string | false | A consumer-provided prefix to include on any downloaded file name. Max length is 50 characters and can only contain alphanumeric characters, hyphen (-), or an underscore (_). |
dateTimeStampSuffix | boolean | false | Indicates whether to include a date timestamp as a suffix on any downloaded file name. Defaults to true. Default: true |
serverName | string | false | The name of the server to upload metadata. |
caslibName | string | false | The name of the caslib to upload metadata. |
| Status | Meaning | Description | ||
|---|---|---|---|---|
| 201 | Created | Created. | Headers | Schema |
| 400 | Bad Request | Bad request (the request is not well-formed). | Schema | |
| 401 | Unauthorized | Not authenticated. | Schema | |
| 403 | Forbidden | The user does not have permission to complete this request. | Schema | |
| 404 | Not Found | The Catalog service is not available. | Schema | |
| 406 | Not Acceptable | Not Acceptable. Include an Accept header with a supported value on the request. | Schema | |
| 415 | Unsupported Media Type | Unsupported Media Type. Include a Content-Type header with a supported value in the request. | Schema | |
| 500 | Internal Server Error | The Catalog service encountered an error. | Schema |