Lookup API Reference
API Reference/Lookup

Lookup

For authentication instructions, see API overview.

Endpoints

get/api/v2/lookupvalues
post/api/v2/lookupvalues
get/api/v2/lookupvalues/:id
put/api/v2/lookupvalues/:id
patch/api/v2/lookupvalues/:id
post/api/v2/migrate-lookupvalues
get

List all lookup values

Returns a list of lookup values. The lookup values are returned in sorted order, with the most recent appearing first.

Query parameters

  • limitinteger

    The number of records to return

  • pageinteger

    The page number

  • orderstring

    The order of the records

  • sortBystring

    The sort of the records

  • fieldsstring

    The filter of the records

  • pstring

    policyFilters

  • qstring

    search query

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/lookupvalues

Response

No response schema
post

Create lookup values

Create lookup values. You need to pass through any required fields, and you can optionally pass through other fields.

Request body

  • lookupObjectIdstring
  • keystring
  • langstring
  • valuestring
  • descriptionstring
  • imagestring
  • propertiesarray
  • activeboolean
  • validFromDatestring
  • validToDatestring
  • scopestring

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X POST -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/lookupvalues \
	-d 'lookupObjectId="609a8f85c2834915d0a5a5e8"' \
	-d 'key="10001"' \
	-d 'lang="en"' \
	-d 'value="value1"' \
	-d 'description="description1"' \
	-d 'image="image1"' \
	-d 'properties="array"' \
	-d 'active=true' \
	-d 'validFromDate="2023-04-19"' \
	-d 'validToDate="2023-04-19"' \
	-d 'scope="public"'

Response

No response schema
get

Retrieve lookup values

Returns a single lookup value, which you can request by passing through an id in the url.

Path parameters

  • idstring

    ID of the lookup value

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/lookupvalues/:id

Response

No response schema
put

Update lookup values

Path parameters

  • idstring

    ID of the lookup value

Request body

  • lookupObjectIdstring
  • keystring
  • langstring
  • valuestring
  • descriptionstring
  • imagestring
  • propertiesarray
  • activeboolean
  • validFromDatestring
  • validToDatestring
  • scopestring

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X PUT \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/lookupvalues/:id \
	-d 'lookupObjectId="609a8f85c2834915d0a5a5e8"' \
	-d 'key="10001"' \
	-d 'lang="en"' \
	-d 'value="value1"' \
	-d 'description="description1"' \
	-d 'image="image1"' \
	-d 'properties="array"' \
	-d 'active=true' \
	-d 'validFromDate="2023-04-19"' \
	-d 'validToDate="2023-04-19"' \
	-d 'scope="public"'

Response

No response schema
patch

Update lookup values soft

Update lookup values soft by setting the values of the parameters passed. Any parameters not set will be unchanged.

Path parameters

  • idstring

    ID of the lookup value

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/lookupvalues/:id

Response

No response schema
post

Create migrate lookup

Create migrate lookup. You need to pass through any required fields, and you can optionally pass through other fields.

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X POST -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/migrate-lookupvalues

Response

No response schema