Locations Swagger API

GET /archivist/v2/locations

List locations

Returns a paginated list of locations

Query Parameters

  • order_by (string) – Specify the sort order for the results. By display_name and by named extended attribute are supported.

  • page_size (integer) – Maximum locations per page

  • page_token (string) – The next_page_token returned from a previous list request if any.

  • display_name (string) – Further fields are bound to query parameters and act to filter the result

  • description (string) –

Status Codes

  • 200 OK – A successful response.

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 403 Forbidden – Returned when the user is not authorized to read the location.

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • default – An unexpected error response.

Response JSON Object

  • locations[].attributes (object) – key value mapping of asset properties

  • locations[].description (string) – Free text description of the location

  • locations[].display_name (string) – Customer friendly name for the location.

  • locations[].identity (string) – Unique identification for the location, Relative Resource Name

  • locations[].latitude (number) – Latitude in decimal degrees

  • locations[].longitude (number) – Longitude in decimal degrees

  • locations[].owner (string) – wallet address of the location owner

  • locations[].tenant (string) – Tenent id

  • next_page_token (string) – Token to retrieve the next page of results or empty if there are none.

POST /archivist/v2/locations

Create a location

Create a new location.

Request JSON Object

  • attributes (object) – key value mapping of location properties

  • description (string) – Free text description of the location

  • display_name (string) – Customer friendly name for the location. (required)

  • latitude (number) – Latitude in decimal degrees format. (required)

  • longitude (number) – longitude in decimal degrees format. (required)

Status Codes

  • 200 OK – A successful response.

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 402 Payment Required – Returned when the user’s quota of locations policies has been reached.

  • 403 Forbidden – Returned when the user is not authorized to create a location.

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • default – An unexpected error response.

Response JSON Object

  • attributes (object) – key value mapping of asset properties

  • description (string) – Free text description of the location

  • display_name (string) – Customer friendly name for the location.

  • identity (string) – Unique identification for the location, Relative Resource Name

  • latitude (number) – Latitude in decimal degrees

  • longitude (number) – Longitude in decimal degrees

  • owner (string) – wallet address of the location owner

  • tenant (string) – Tenent id

GET /archivist/v2/locations/{uuid}

Get a location

Returns the identified location

Parameters

  • uuid (string) – Specify the Location UUID where locations/{uuid} is the Location Identity e.g. add30235-1424-4fda-840a-d5ef82c4c96f from Identity locations/add30235-1424-4fda-840a-d5ef82c4c96f

Status Codes

  • 200 OK – A successful response.

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 403 Forbidden – Returned when the user is not authorized to read the location.

  • 404 Not Found – Returned when the identified location does not exist.

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • default – An unexpected error response.

Response JSON Object

  • attributes (object) – key value mapping of asset properties

  • description (string) – Free text description of the location

  • display_name (string) – Customer friendly name for the location.

  • identity (string) – Unique identification for the location, Relative Resource Name

  • latitude (number) – Latitude in decimal degrees

  • longitude (number) – Longitude in decimal degrees

  • owner (string) – wallet address of the location owner

  • tenant (string) – Tenent id

DELETE /archivist/v2/locations/{uuid}

Delete a location

Delete the identified location

Parameters

  • uuid (string) – Specify the Location UUID where locations/{uuid} is the Location Identity e.g. add30235-1424-4fda-840a-d5ef82c4c96f from Identity locations/add30235-1424-4fda-840a-d5ef82c4c96f

Status Codes

  • 200 OK – A successful response.

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 403 Forbidden – Returned when the user is not authorized to delete the location.

  • 404 Not Found – Returned when the identified location does not exist.

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • default – An unexpected error response.

PATCH /archivist/v2/locations/{uuid}

Update a location’s details

Perform a full or partial update of the identified location

Parameters

  • uuid (string) – Specify the Location UUID where locations/{uuid} is the Location Identity e.g. add30235-1424-4fda-840a-d5ef82c4c96f from Identity locations/add30235-1424-4fda-840a-d5ef82c4c96f

Query Parameters
Request JSON Object

  • attributes (object) – key value mapping of asset properties

  • description (string) – Free text description of the location

  • display_name (string) – Customer friendly name for the location.

  • identity (string) – Unique identification for the location, Relative Resource Name

  • latitude (number) – Latitude in decimal degrees

  • longitude (number) – Longitude in decimal degrees

  • owner (string) – wallet address of the location owner

  • tenant (string) – Tenent id

Status Codes

  • 200 OK – A successful response.

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 403 Forbidden – Returned when the user is not authorized to update the location.

  • 404 Not Found – Returned when the identified location does not exist.

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • default – An unexpected error response.

Response JSON Object

  • attributes (object) – key value mapping of asset properties

  • description (string) – Free text description of the location

  • display_name (string) – Customer friendly name for the location.

  • identity (string) – Unique identification for the location, Relative Resource Name

  • latitude (number) – Latitude in decimal degrees

  • longitude (number) – Longitude in decimal degrees

  • owner (string) – wallet address of the location owner

  • tenant (string) – Tenent id

GET /archivist/v2/locations/{uuid}/permissions

Get location permissions

Get location permissions for identified location

Parameters

  • uuid (string) – Specify the Location UUID where locations/{uuid} is the Location Identity e.g. add30235-1424-4fda-840a-d5ef82c4c96f from Identity locations/add30235-1424-4fda-840a-d5ef82c4c96f

Status Codes

  • 200 OK – A successful response.

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 403 Forbidden – Returned when the user is not authorized to list permissions for the location.

  • 404 Not Found – Returned when the identified location does not exist.

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • default – An unexpected error response.

Response JSON Object

  • location_identity (string) – The location identity in the form: locations/{uuid} (read only)

  • permissions.subject_identities[] (string) –

PATCH /archivist/v2/locations/{uuid}/permissions

Patch location permissions

Patch location permissions for identified location

Parameters

  • uuid (string) – Specify the Location UUID where locations/{uuid} is the Location Identity e.g. add30235-1424-4fda-840a-d5ef82c4c96f from Identity locations/add30235-1424-4fda-840a-d5ef82c4c96f

Request JSON Object

  • subject_identities[] (string) –

Status Codes

  • 200 OK – A successful response.

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 403 Forbidden – Returned when the user is not authorized to access permissions for the location.

  • 404 Not Found – Returned when the identified location does not exist.

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • default – An unexpected error response.

Response JSON Object

  • location_identity (string) – The location identity in the form: locations/{uuid} (read only)

  • permissions.subject_identities[] (string) –

GET /archivist/v2/locations:caps

Get remaining capped resources for Locations

Not stable or officially supported. Get remaining capped resources for Locations

Status Codes

  • 200 OK – A successful response.

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • default – An unexpected error response.

Response JSON Object

  • caps[].resource_remaining (string) – Number of capped resources remaining

  • caps[].resource_type (string) – String identifying the capped resource type

GET /archivist/v2/locations:openapi

Get OpenAPI spec for Locations

Get OpenAPI v2.0 spec for Locations

Status Codes

  • 200 OK – A successful response.

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • default – An unexpected error response.

GET /archivist/v2/locations:openapi-ui

Get OpenAPI UI for Locations

Get OpenAPI v2.0 UI for Locations

Status Codes

  • 200 OK – A successful response.

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • default – An unexpected error response.