Manage UP42 assets

Overview

After an order is fulfilled, you can view and manage the delivered assets in your storage.

You can also manage assets through the console.

See assets

To see a list of assets in storage, call the /v2/assets endpoint.

Request

GET /v2/assets HTTP/1.1
Host: api.up42.com
Authorization: Bearer {token}

Query parameter	Overview
`createdAfter`	string Search for assets created after the specified timestamp.
`createdBefore`	string Search for assets created before the specified timestamp.
`workspaceId`	string Search by the workspace ID.
`collectionNames`	array of strings Search for assets from any of the provided geospatial collections.
`producerNames`	array of strings Search for assets from any of the provided producers.
`tags`	array of strings Search for assets with any of the provided tags.
`sources`	array of strings Search for assets from any of the provided sources: `ARCHIVE` `TASKING` `ANALYTICS` `USER` `PROCESSING`
`search`	string Search for assets that contain the provided search query in their name, title, or order ID.
`page`	integer The result page number. To get the first page, set the parameter to 0. The default value is `0`.
`size`	integer The number of results on a result page. The default value is `20`.
`sort`	string The results sorting method based on a chosen field. The format is `<field name>,<asc or desc>`. The allowed sort properties: `name`, `title`, `size`, `createdAt`, `updatedAt`, `source`, `collectionName`, and `producerName`.

Response

See response example

{
  "content": [
    {
      "id": "8fbccd60-c828-4d8c-a4ef-3c2730d9d6bc",
      "workspaceId": "a19e9ab6-afad-461f-8043-ce19cfd0985b",
      "accountId": "69353acb-f942-423f-8f32-11d6d67caa77",
      "createdAt": "2023-08-22T17:06:20.652310Z",
      "updatedAt": "2023-08-22T17:07:56.914948Z",
      "name": "oneatlas_bd1ef383-f14c-45d1-a012-a4ab7261153a.zip",
      "size": 256248634,
      "contentType": "application/gzip",
      "geospatialMetadataExtractionStatus": "SUCCESSFUL",
      "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "orderId": "bd1ef380-f14c-48d8-a013-e4ab7261153b",
      "producerName": "airbus",
      "collectionName": "spot",
      "source": "ARCHIVE",
      "title": "SPOT 6/7 NY Central Park",
      "tags": ["optical", "US"]
    }
  ],
  "pageable": {},
  "last": true,
  "size": 0,
  "first": true,
  "empty": true,
  "number": 0,
  "numberOfElements": 0,
  "totalElements": 0,
  "totalPages": 0,
  "sort": {}
}

Parameter	Overview
`content.id`	string The asset ID.
`content.` `workspaceId`	string The workspace ID.
`content.` `accountId`	string The account ID.
`content.` `createdAt`	string The timestamp when the asset was created.
`content.` `updatedAt`	string The timestamp when the asset was last updated.
`content.name`	string The asset name.
`content.size`	integer The asset size.
`content.` `contentType`	string The asset file format.
`content.` `geospatialMetadata` `ExtractionStatus`	string The status of geospatial metadata extraction: `SUCCESSFUL` `FAILED` `IN_PROGRESS` `NOT_PROCESSED` If `SUCCESSFUL`, the asset is a geospatial asset.
`content.productId`	string The data product ID.
`content.` `orderId`	string The order ID.
`content.` `producerName`	string The company that initially acquired and processed the source data.
`content.` `collectionName`	string The geospatial collection name.
`content.source`	string The asset source: `ARCHIVE` `TASKING` `ANALYTICS` `USER` `PROCESSING`
`content.title`	string An editable asset title.
`content.tags`	Array of strings An editable list of tags to categorize the asset.

See asset metadata

To see metadata for a particular asset, call the /v2/assets/{asset-id}/metadata endpoint with the asset ID as a path parameter.

Request

GET /v2/assets/{asset-id}/metadata HTTP/1.1
Host: api.up42.com
Authorization: Bearer {token}

Response

The response is an object from the /v2/assets content array.

See response example

{
  "id": "8fbccd60-c828-4d8c-a4ef-3c2730d9d6bc",
  "workspaceId": "a19e9ab6-afad-461f-8043-ce19cfd0985b",
  "accountId": "69353acb-f942-423f-8f32-11d6d67caa77",
  "createdAt": "2023-08-22T17:06:20.652310Z",
  "updatedAt": "2023-08-22T17:07:56.914948Z",
  "name": "oneatlas_bd1ef383-f14c-45d1-a012-a4ab7261153a.zip",
  "size": 256248634,
  "contentType": "application/gzip",
  "geospatialMetadataExtractionStatus": "SUCCESSFUL",
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "orderId": "bd1ef380-f14c-48d8-a013-e4ab7261153b",
  "producerName": "airbus",
  "collectionName": "spot",
  "source": "ARCHIVE",
  "title": "SPOT 6/7 NY Central Park",
  "tags": [
    "optical",
    "US"
  ]
}

Update asset metadata

To change an asset's title and tags, call the v2/assets/{asset-id}/metadata endpoint with the asset ID as a path parameter.

Request

POST /v2/assets/{asset-id}/metadata HTTP/1.1
Host: api.up42.com
Content-Type: application/json
Authorization: Bearer {token}

Parameter	Overview
`title`	string An editable asset title between 1 and 250 characters.
`tags`	array of strings An editable list of tags to categorize the asset.

See request example

{
  "title": "SPOT 6/7 NY Central Park",
  "tags": ["optical", "US"]
}

Response

The response is the updated object from the /v2/assets content array.

See response example

{
  "id": "8fbccd60-c828-4d8c-a4ef-3c2730d9d6bc",
  "workspaceId": "a19e9ab6-afad-461f-8043-ce19cfd0985b",
  "accountId": "69353acb-f942-423f-8f32-11d6d67caa77",
  "createdAt": "2023-08-22T17:06:20.652310Z",
  "updatedAt": "2023-08-22T17:07:56.914948Z",
  "name": "oneatlas_bd1ef383-f14c-45d1-a012-a4ab7261153a.zip",
  "size": 256248634,
  "contentType": "application/gzip",
  "geospatialMetadataExtractionStatus": "SUCCESSFUL",
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "orderId": "bd1ef380-f14c-48d8-a013-e4ab7261153b",
  "producerName": "airbus",
  "collectionName": "spot",
  "source": "ARCHIVE",
  "title": "SPOT 6/7 NY Central Park",
  "tags": ["optical", "US"]
}