Sidra API module: Metadata

It contains endpoints to implement CRUD operations -Create, Read, Update, Delete- over the meta-information related to assets. More information can be found in the Asset metadata section.

Assets

It allows retrieving assets using different filters to select them:

  • Retrieving all the assets that are associated to an entity.
  • Retrieving a specific asset based on its identifier.
  • Retrieving all the assets that are associated to a list of entities and have a LastUpdate field posterior to a minimum date.

Assets can not be created using the API. They are created when a new file is ingested in the platform.

AssetStatus

It allows to retrieve the list of status in which an asset can be. The set of status is static and defined by the platform, it cannot be modified.

AttributeFormats

It contains CRUD endpoints to the AttributeFormat metadata. Attribute formats must be related to an attribute and it is required to provide the attribute id during its creation.

Attributes

It contains CRUD endpoints to the Attribute metadata. Attributes must be related to an entity and it is required to provide the identity id during its creation.

Entities

It contains CRUD endpoints to:

  • The Entity metadata.
  • The association between an entity and a pipeline. Both must be created before establish the association between them. Updating the association is not supported.
  • The association between tags and entities. Creating the association between an entity and a tag also creates the tag. Updating the association is not supported.

Also provides endpoints to:

  • Create attributes in bulk and associate them to an entity.
  • Update the LastUpdate field of an entity, so it will be deployed in the next data ingestion execution.

Providers

It contains CRUD endpoints to:

  • The Provider metadata.
  • The association between tags and providers. Creating the association between a provider and a tag also creates the tag. Updating the association is not supported.

Also provides endpoints to:

  • Update the LastUpdate field of all the entities related to the provider, so they will be deployed in the next data ingestion execution.

Tags

It allows to retrieve the list of tags defined in the platform. Tags can be assigned to entities and to providers. The way to create a new tag is using the endpoints to assign it to an entity or provider.

When creating new tags, it must be provided the Id of the type of tag. These are the available tag types:

Id Name Description
1 Autogen A system tag automatically created such as sensitive data
2 UserProvided A user added tag for a given provider

It should always be used UserProvided type of tags.