Resolve objects by ids

POST/api/objects/by-handle/{handle}/by-ids

Returns lightweight object options for the provided record ids.

Path Parameters

handle*string

Stable handle used in routes and lookups.

Example"projects"

Request Body

application/json

Request payload for Resolve objects by ids.

TypeScript Definitions

Use the request body type in TypeScript.

ids*array<>

Object record identifiers to resolve.

Example

[  "objrec_123",  "objrec_456"]

Response Body

`application/json`

curl -X POST "https://example.com/api/objects/by-handle/projects/by-ids" \  -H "Content-Type: application/json" \  -d '{    "ids": [      "objrec_123",      "objrec_456"    ]  }'

[  {    "id": "objrec_123",    "name": "Airport Expansion",    "subtitle": "Active opportunity",    "iconUrl": "https://www.google.com/s2/favicons?domain=github.com&sz=64"  }]

{  "_tag": "ApiBadRequestError",  "code": "PRICE_IMPORT_DUPLICATE_SKUS",  "message": "The request payload is invalid.",  "description": "Remove duplicate SKU rows before importing the file.",  "details": null}

{  "_tag": "Unauthorized"}

{  "_tag": "ApiForbiddenError",  "message": "You do not have permission to perform this action."}

{  "_tag": "ApiNotFoundError",  "message": "The requested resource was not found."}

{  "_tag": "ApiConflictError",  "message": "A resource with this handle already exists."}

{  "_tag": "ApiUnprocessableEntityError",  "message": "The order cannot be submitted without items."}

{  "_tag": "ServiceUnavailable"}

{  "_tag": "ApiTimeoutError",  "message": "The upstream operation timed out."}

Resolve objects by ids

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`