SIsimscale
Data Repository

Read the metadata of a data object.

Changed on
get/data-repository/data/{dataId}

Request

  • Base URL
    https://api.simscale.com/v1
  • URL
    https://api.simscale.com/v1/data-repository/data/{dataId}
  • Auth
    API key in header X-API-KEY

Path parameters

dataIdstring required

Response

Ok

contentTypestring nullable
createdByinteger nullable
creationTimestampstring date-time
dataIdstring

Data identifier. It is a string composed of the type identifier and a UUID: data:[UUID].

dataProviderType'INTERNAL' | 'EXTERNAL'

Identifies if a data is

  • INTERNAL: data is stored and managed by data-repository service or
  • EXTERNAL: data is stored and managed by an external service. Only a reference for it is stored in data-repository service.
dataSizeinteger nullable
dataTypestring

Reference to a component version.

Components are organized into a group hierarchy which serves as a qualification mechanism to avoid collisions and also to group components semantically.

Component versions follow the convention of semantic versioning.

The fully qualified reference of a component version follows the following syntax: [component_group]:[component]:[component_version].

data_info_typestring required
descriptionstring nullable
origin'USER_UPLOAD' | 'WORKFLOW_EXECUTION' nullable

Identifies the origin of data creation:

  • USER_UPLOAD: data was uploaded or registered directly by a user through the API
  • WORKFLOW_EXECUTION: data was created as a result of a workflow run
originalFileNamestring nullable
projectIdstring

Example response

{
  "dataId": "data:3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "dataType": "simscale.cad.data-types:cad-model"
}

Changes