Get Assets

GET /assets

Retrieve the assets used in a given program

Request Parameters

Query Parameters

Name	Type	Description
search	string	Term will be searched for in any field
page	integer	Default: 1
size	integer	Default: 50

Header Parameters

Name	Type	Description
program-id required	string

Responses

200 Successful Response

PageAsset | application/json

Name	Type	Properties
items required	array	items: {'$ref': '#/components/schemas/Asset'}
total required	integer	minimum: 0.0
page required	integer	minimum: 1.0
size required	integer	minimum: 1.0

Asset | application/json

Name	Type	Properties
asset_id required	string	maxLength: 64
asset_name	string	maxLength: 124
labels	array	items: {}

Response Example

{
  "items": [
    {
      "asset_id": "string",
      "asset_name": "string",
      "labels": "array"
    }
  ],
  "total": "integer",
  "page": "integer",
  "size": "integer"
}

422 Validation Error

HTTPValidationError | application/json

Name	Type	Properties
detail	array	items: {'$ref': '#/components/schemas/ValidationError'}

ValidationError | application/json

Name	Type	Properties
loc required	array	items: {'anyOf': [{'type': 'string'}, {'type': 'integer'}]}
msg required	string
type required	string