Download instances

get/instances
Internal-Use Only

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

Request Samples

1

Response Samples

1libraryName,tableName,tableLabel,tableDescription,tableType,numberOfColumns,numberOfRows,tableSize,tableEncoding,tableReviewStatus,tableDateCreated,tableCreatedBy,tableDateModified,tableModifiedBy,columnName,columnOrdinalPosition,columnLabel,columnDescription,columnDataType,columnLength,columnFormat SASHELP,cars,2004 Car Data,,sasTable,15,428,196608,us-ascii  ASCII (ANSI),none,"Mon, 06 Feb 2023 19:00:02 UTC",sas,"Mon, 06 Feb 2023 19:00:02 UTC",sas,Make,1,,,char,13,, SASHELP,cars,2004 Car Data,,sasTable,15,428,196608,us-ascii  ASCII (ANSI),none,"Mon, 06 Feb 2023 19:00:02 UTC",sas,"Mon, 06 Feb 2023 19:00:02 UTC",sas,Model,2,,,char,40,, SASHELP,cars,2004 Car Data,,sasTable,15,428,196608,us-ascii  ASCII (ANSI),none,"Mon, 06 Feb 2023 19:00:02 UTC",sas,"Mon, 06 Feb 2023 19:00:02 UTC",sas,Type,3,,,char,8,, SASHELP,cars,2004 Car Data,,sasTable,15,428,196608,us-ascii  ASCII (ANSI),none,"Mon, 06 Feb 2023 19:00:02 UTC",sas,"Mon, 06 Feb 2023 19:00:02 UTC",sas,Origin,4,,,char,6,, SASHELP,cars,2004 Car Data,,sasTable,15,428,196608,us-ascii  ASCII (ANSI),none,"Mon, 06 Feb 2023 19:00:02 UTC",sas,"Mon, 06 Feb 2023 19:00:02 UTC",sas,DriveTrain,5,,,char,5,, SASHELP,cars,2004 Car Data,,sasTable,15,428,196608,us-ascii  ASCII (ANSI),none,"Mon, 06 Feb 2023 19:00:02 UTC",sas,"Mon, 06 Feb 2023 19:00:02 UTC",sas,MSRP,6,,,num,8,DOLLAR8. SASHELP,cars,2004 Car Data,,sasTable,15,428,196608,us-ascii  ASCII (ANSI),none,"Mon, 06 Feb 2023 19:00:02 UTC",sas,"Mon, 06 Feb 2023 19:00:02 UTC",sas,Invoice,7,,,num,8,DOLLAR8. SASHELP,cars,2004 Car Data,,sasTable,15,428,196608,us-ascii  ASCII (ANSI),none,"Mon, 06 Feb 2023 19:00:02 UTC",sas,"Mon, 06 Feb 2023 19:00:02 UTC",sas,EngineSize,8,Engine Size (L),,,num,8,, SASHELP,cars,2004 Car Data,,sasTable,15,428,196608,us-ascii  ASCII (ANSI),none,"Mon, 06 Feb 2023 19:00:02 UTC",sas,"Mon, 06 Feb 2023 19:00:02 UTC",sas,Cylinders,9,,,num,8,, SASHELP,cars,2004 Car Data,,sasTable,15,428,196608,us-ascii  ASCII (ANSI),none,"Mon, 06 Feb 2023 19:00:02 UTC",sas,"Mon, 06 Feb 2023 19:00:02 UTC",sas,Horsepower,10,,,num,8,, SASHELP,cars,2004 Car Data,,sasTable,15,428,196608,us-ascii  ASCII (ANSI),none,"Mon, 06 Feb 2023 19:00:02 UTC",sas,"Mon, 06 Feb 2023 19:00:02 UTC",sas,MPG_City,11,MPG (City),,,num,8,, SASHELP,cars,2004 Car Data,,sasTable,15,428,196608,us-ascii  ASCII (ANSI),none,"Mon, 06 Feb 2023 19:00:02 UTC",sas,"Mon, 06 Feb 2023 19:00:02 UTC",sas,MPG_Highway,12,MPG (Highway),,num,8,, SASHELP,cars,2004 Car Data,,sasTable,15,428,196608,us-ascii  ASCII (ANSI),none,"Mon, 06 Feb 2023 19:00:02 UTC",sas,"Mon, 06 Feb 2023 19:00:02 UTC",sas,Weight,13,Weight (LBS),,num,8,, SASHELP,cars,2004 Car Data,,sasTable,15,428,196608,us-ascii  ASCII (ANSI),none,"Mon, 06 Feb 2023 19:00:02 UTC",sas,"Mon, 06 Feb 2023 19:00:02 UTC",sas,Wheelbase,14,Wheelbase (IN),,num,8,, SASHELP,cars,2004 Car Data,,sasTable,15,428,196608,us-ascii  ASCII (ANSI),none,"Mon, 06 Feb 2023 19:00:02 UTC",sas,"Mon, 06 Feb 2023 19:00:02 UTC",sas,Length,15,Length (IN),,num,8,,

Query Parameters

NameTypeRequiredDescription
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. %3B).

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.

Header Parameters

NameTypeRequiredDescription
Accept
string
false

The desired representation for the response. Defaults to text/csv.

Allowed value:
text/csv
Default:
text/csv

Responses

StatusMeaningDescription
200OKOK.HeadersSchema
400Bad RequestBad request (the request is not well-formed).Schema
401UnauthorizedNot authenticated.Schema
403ForbiddenThe user does not have permission to complete this request.Schema
404Not FoundThe Catalog service is not available.Schema
406Not AcceptableNot Acceptable. Include an Accept header with a supported value on the request.Schema