Download instances
Downloads resulting metadata for instances. 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.
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
| Name | Type | Required | Description |
|---|---|---|---|
dateTimeStampSuffix | boolean | false | Indicates whether to include a date timestamp as a suffix on any downloaded file name. Defaults to true. Default: true |
delimiter | string<enumeration> | false | The delimiter to use to separate individual fields within a row. Defaults to comma (","). Note that the encoded value will need to be provided for semi-colon (i.e. Allowed values: ,; Default: , |
filter | string<filter-criteria> | false | Filter criteria for returned objects. See Filtering in REST APIs. |
level | string<enumeration> | false | The level or degree of complexity of metadata to be included. Allowed values: dataDictionarydataDictionaryAndProfiledetailedMetrics Default: dataDictionary |
limit | integer | false | Maximum number of objects to return. Defaults to 10. |
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 (_). |
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. |
| Status | Meaning | Description | ||
|---|---|---|---|---|
| 200 | OK | OK. | 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 |