ATataccama
Data Products

List data product statuses

List the published statuses that can be assigned to data products.

To return extra properties, list the property names you need in the extraProperties parameter.

Paging is forward-only.

get/catalog/v1/data-product-statuses

Request

Query parameters

afterstring

Cursor for forward pagination. Use the value from meta.next in the previous response. Starts at the beginning when omitted.

sizeinteger

Number of statuses to return per page.

searchstring

Full-text query matched against all string properties of the status, such as name.

namestring

Filters results by exact match on the status name.

sortstring[]

Comma-separated field names for sorting results, where fields prefixed with a hyphen (-) sort descending. Only name is supported.

Examples:

  • ?sort=name — sort by name ascending
  • ?sort=-name — sort by name descending
[
  "name"
]
extraPropertiesstring[]

Comma-separated list of extra property names to include in the extraProperties field of the response. When omitted, no extra properties are returned.

The property names must exactly match the property names defined in the metadata model. Only scalars, references and their arrays are supported.

To find which extra properties are available for an entity, retrieve its entity definition through the Metadata model entities endpoints: catalogItem for catalog items, attribute for catalog attributes, source for sources, folder for folders, dataProduct for data products, dataProductStatus for data product statuses, domain for domains, and the term's own type (for example, businessTerm) for terms. Extra properties cannot be used as filter criteria.

[
  "isPii",
  "community",
  "domains"
]

Response

Paginated list of data product statuses.

Example response

{
  "meta": {
    "next": "MjA=",
    "total": 150
  },
  "data": [
    {
      "urn": "urn:ata:acme-corp:catalog:data-product-status:7c3e9a5d-4b6f-4a0c-8d8e-2f3a4b5c6d7e",
      "name": "Managed"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.