API Package Operation Response

object
* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

The API Operation identifier.

Example:0f5061ce-78f6-4452-9108-ad7c02821fd6

apiobjectrequiredread-only
* Additional properties are NOT allowed.
Show Child Parameters
methodstringrequiredread-only

The HTTP method of an API Operation.

Allowed values:GETPOSTPUTDELETEPATCHOPTIONSHEADCONNECTTRACE

pathstringrequiredread-only

The path of the API Operation.

Example:/users/{user_id}

rate_limiting_configobjectrequiredread-only

Rate limit configuration that can be applied to an API Package or an API Package Operation.

* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

implementation_statusobject

The implementation status of the operation.

* Additional properties are NOT allowed.
Show Child Parameters
Example

Method

string

The HTTP method of an API Operation.

Allowed values:GETPOSTPUTDELETEPATCHOPTIONSHEADCONNECTTRACE

Rate Limiting configuration

object

Rate limit configuration that can be applied to an API Package or an API Package Operation.

* Additional properties are NOT allowed.
limitintegerrequired

The amount of requests allowed for each operation within the specified duration.

>= 0

durationstringrequired

The timeframe to ensure that an application does not exceed the request limit.

Allowed values:secondsminuteshours

Example

UuidFieldFilter

object

Filter using one of the following operators: eq, oeq, neq

* Additional properties are NOT allowed.
eqstring

The field exactly matches the provided value.

Example:?filter[field_name_here][eq]=foo

oeqstring

The field matches any of the provided values.

Example:?filter[field_name_here][oeq]=foo,bar

neqstring

The field does not match the provided value.

Example:?filter[field_name_here][neq]=bar

Example

StringFieldFilter

One Of
eqstring

The field exactly matches the provided value.

Example:?filter[field_name_here][eq]=foo

containsstring

The field contains the provided value.

Example:?filter[field_name_here][contains]=foo

ocontainsstring

The field contains any of the provided values.

Example:?filter[field_name_here][ocontains]=foo,bar

oeqstring

The field matches any of the provided values.

Example:?filter[field_name_here][oeq]=foo,bar

neqstring

The field does not match the provided value.

Example:?filter[field_name_here][neq]=bar

Example