Returns one security-filtered page from an allowlisted operational system Entity Definition.

GET

/api/workspace/work-schedule/catalogs/{catalogKey}/lookup

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://example.com/api/workspace/work-schedule/catalogs/example/lookup"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/work-schedule/catalogs/example/lookup';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/workspace/work-schedule/catalogs/example/lookup \
  --header 'Authorization: Bearer <token>'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

catalogKey

required

string

Allowlisted catalog key: OperationalLocation, Site, or Worker.

Query Parameters

Search

string

Optional case-insensitive search over system DisplayName and Number only.

Page

integer format: int32

One-based page number.

PageSize

integer format: int32

Page size from 1 through 100.

ExcludedInstanceIds

Array<string>

Exclude configuration-owned identities before secured pagination; never widens View.

IncludeArchived

boolean

Include readable archived records when projecting retained configuration references.

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Responses

200

application/json

object

Data

One security-filtered page of operational catalog lookup items.

object

CatalogKey

Allowlisted Work Schedule catalog key.

string

nullable

EntityDefinitionId

Resolved system Entity Definition identifier.

string

nullable

Items

Current page of readable active Entity Instances.

Array<object>

nullable

One field-safe operational catalog lookup item.

object

Entity Instance identifier.

string

nullable

DisplayName

Resolved Entity Instance display name.

string

nullable

Number

Server-generated Entity Instance number.

string

nullable

SchedulingValues

Allowlisted scheduling values readable by the current actor.

object

key

additional properties

string

nullable

TotalCount

Total readable active Entity Instance count after search.

integer format: int32

Page

One-based page number.

integer format: int32

PageSize

Requested page size.

integer format: int32

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

One security-filtered page of operational catalog lookup items.

object

CatalogKey

Allowlisted Work Schedule catalog key.

string

nullable

EntityDefinitionId

Resolved system Entity Definition identifier.

string

nullable

Items

Current page of readable active Entity Instances.

Array<object>

nullable

One field-safe operational catalog lookup item.

object

Entity Instance identifier.

string

nullable

DisplayName

Resolved Entity Instance display name.

string

nullable

Number

Server-generated Entity Instance number.

string

nullable

SchedulingValues

Allowlisted scheduling values readable by the current actor.

object

key

additional properties

string

nullable

TotalCount

Total readable active Entity Instance count after search.

integer format: int32

Page

One-based page number.

integer format: int32

PageSize

Requested page size.

integer format: int32

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

application/json

object

Data

One security-filtered page of operational catalog lookup items.

object

CatalogKey

Allowlisted Work Schedule catalog key.

string

nullable

EntityDefinitionId

Resolved system Entity Definition identifier.

string

nullable

Items

Current page of readable active Entity Instances.

Array<object>

nullable

One field-safe operational catalog lookup item.

object

Entity Instance identifier.

string

nullable

DisplayName

Resolved Entity Instance display name.

string

nullable

Number

Server-generated Entity Instance number.

string

nullable

SchedulingValues

Allowlisted scheduling values readable by the current actor.

object

key

additional properties

string

nullable

TotalCount

Total readable active Entity Instance count after search.

integer format: int32

Page

One-based page number.

integer format: int32

PageSize

Requested page size.

integer format: int32

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Conflict

application/json

object

Data

One security-filtered page of operational catalog lookup items.

object

CatalogKey

Allowlisted Work Schedule catalog key.

string

nullable

EntityDefinitionId

Resolved system Entity Definition identifier.

string

nullable

Items

Current page of readable active Entity Instances.

Array<object>

nullable

One field-safe operational catalog lookup item.

object

Entity Instance identifier.

string

nullable

DisplayName

Resolved Entity Instance display name.

string

nullable

Number

Server-generated Entity Instance number.

string

nullable

SchedulingValues

Allowlisted scheduling values readable by the current actor.

object

key

additional properties

string

nullable

TotalCount

Total readable active Entity Instance count after search.

integer format: int32

Page

One-based page number.

integer format: int32

PageSize

Requested page size.

integer format: int32

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

503

Service Unavailable

application/json

object

Data

One security-filtered page of operational catalog lookup items.

object

CatalogKey

Allowlisted Work Schedule catalog key.

string

nullable

EntityDefinitionId

Resolved system Entity Definition identifier.

string

nullable

Items

Current page of readable active Entity Instances.

Array<object>

nullable

One field-safe operational catalog lookup item.

object

Entity Instance identifier.

string

nullable

DisplayName

Resolved Entity Instance display name.

string

nullable

Number

Server-generated Entity Instance number.

string

nullable

SchedulingValues

Allowlisted scheduling values readable by the current actor.

object

key

additional properties

string

nullable

TotalCount

Total readable active Entity Instance count after search.

integer format: int32

Page

One-based page number.

integer format: int32

PageSize

Requested page size.

integer format: int32

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}