Measure

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

query

$top

integer

No

The maximum documents to return. For example, if top is 100, and skip is 0, the system returns documents 1 to 100.

query

$skip

integer

No

The documents to skip before returning. For example if top is 100 and skip is 100, the system returns documents 101 to 200.

query

$filter

string

No

A filter expression in OData v4 format

query

$orderby

string

No

An order by expression in OData v4 format

query

include_nested

boolean

No

Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)

query

include_mappings

boolean

No

Include the mappings for the document in the response

query

include_entities

[ string ]

No

Specifies entity_types to be populated by nesting mechanism (For example, include_entities=['menu-category'] for menu call - populate a menu with menu categories)

query

include_inactive

boolean

No

Includes the documents that are inactive for the current sites

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

header

X-SITE-IDs

[ string ]

No

The unique identifiers (UIDs) of the site to manage data for

query

$filter

string

No

A filter expression in OData v4 format

query

$top

integer

No

The maximum documents to return. For example, if topis 100, and skip is 0, the system returns documents 1 to 100.

query

$skip

integer

No

The documents to skip before returning. For example, if top is 100, and skip is 100, the system returns documents 101 to 200.

query

$orderby

string

No

An order by expression in OData v4 format

query

effective_date

string

Yes

The date and time to query against. If the entity is updated on a specific date, then specifying an effective_date prior to that date returns a previous version of the entity.

query

entity_ids

[ string ]

No

An array of entity identifiers

query

include_nested

boolean

No

Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)

query

include_mappings

boolean

No

Include the mappings for the document in the response

query

include_mappings_for_entities

[ string ]

No

Specifies entity types for which mappings are presented as a part of the response (For example, include_mappings_for_entities_param=&.

query

include_entities

[ string ]

No

Specifies entity_types to be populated by nesting mechanism (For example, include_entities=['menu-category'] for menu call - populate a menu with menu categories)

query

include_audit

boolean

No

Adds audit fields to each document when returning a result (is_active, is_master, created_at, created_by, updated_at, updated_by)

query

include_inactive

boolean

No

Includes the documents that are inactive for the current sites

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

header

X-SITE-IDs

[ string ]

No

The unique identifiers (UIDs) of the site to manage data for

query

$filter

string

No

A filter expression in OData v4 format

query

$top

integer

No

The maximum documents to return. For example, if top is 100, and skip is 0, the system returns documents 1 to 100.

query

$skip

integer

No

The documents to skip before returning. For example, if top is 100, and skip is 100, system returns documents 101 to 200.

query

$orderby

string

No

An order by expression in OData v4 format

query

effective_date

string

Yes

The date and time to query against. If the entity is updated on a specific date, then specifying an effective_date prior to that date returns a previous version of the entity.

query

entity_ids

[ string ]

No

An array of entity identifiers

query

include_nested

boolean

No

Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)

query

include_entities

[ string ]

No

Specifies entity_types to be populated by nesting mechanism (For example, include_entities=['menu-category'] for menu call - populate a menu with menu categories)

query

include_audit

boolean

No

Adds audit fields to each document when returning a result (is_active, is_master, created_at, created_by, updated_at, updated_by)

query

include_inactive

boolean

No

Includes the documents that are inactive for the current sites

query

include_mappings_for_entities

[ string ]

No

Specifies entity types for which mappings are presented as a part of the response (For example, include_mappings_for_entities_param=&.

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

query

include_nested

boolean

No

Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)

query

include_entities

[ string ]

No

Specifies entity_types to be populated by nesting mechanism (For example, include_entities=['menu-category'] for menu call - populate a menu with menu categories)

body

body

measure_create

Yes

The JSON formatted request

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

path

entity_id

string

Yes

The identifier of the entity

body

body

[ measure_create ]

Yes

The JSON formatted request

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

path

entity_id

string

Yes

The identifier of the entity

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

header

X-SITE-IDs

[ string ]

No

The unique identifiers (UIDs) of the site to manage data for

body

body

[ measure_create ]

Yes

Supports the mappings field (array/boolean) for each document. With mappings: True mappings are created for the current date and sites from the X-SITE-IDs header.

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

path

_id

string

Yes

The identifier of the document

query

include_nested

boolean

No

Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)

query

include_entities

[ string ]

No

Specifies entity_types to be populated by nesting mechanism (For example, include_entities=['menu-category'] for menu call - populate a menu with menu categories)

query

include_mappings_for_entities

[ string ]

No

Specifies entity types for which mappings are presented as a part of the response (For example, include_mappings_for_entities_param=&.

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

path

_id

string

Yes

The identifier of the document

query

include_nested

boolean

No

Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)

query

include_entities

[ string ]

No

Specifies entity_types to be populated by nesting mechanism (For example, include_entities=['menu-category'] for menu call - populate a menu with menu categories)

body

body

measure_edit

No

The JSON of the category being patched

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

path

_id

string

Yes

The identifier of the document

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

body

body

[ measure ]

Yes

The JSON formatted request

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

header

X-SITE-IDs

[ string ]

No

The unique identifiers (UIDs) of the site to manage data for

path

entity_id

string

Yes

The identifier of the entity

query

$top

integer

No

The maximum documents to return. For example, if top is 100, and skip is 0, the system returns documents 1 to 100.

query

$skip

integer

No

The documents to skip before returning. For example, if top is 100, and skip is 100, the system returns documents 101 to 200.

query

$filter

string

No

A filter expression in OData v4 format

query

$orderby

string

No

An order by expression in OData v4 format

query

include_inactive

boolean

No

Includes the documents that inactive for the current sites

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

header

X-SITE-IDs

[ string ]

No

The unique identifiers (UIDs) of the site to manage data for

path

entity_id

string

Yes

The identifier of the entity

body

body

mappings_update_request

Yes

The array of the inventory item venue mappings being added

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

body

body

[ mappping_create_request ]

Yes

The JSON of the measure mapping being added

code

string

Yes

The measure abbreviation

description

string

Yes

The description of the measure

abbreviations

[ string ]

Yes

The measure abbreviation associations

_id

_id

No

company_id

company_id

No

entity_id

entity_id

No

is_master

is_master

No

is_active

is_active

No

external_id

external_id

No

created_by

created_by

No

updated_by

updated_by

No

created_at

created_at

No

updated_at

updated_at

No

code

string

Yes

The measure abbreviation

description

string

Yes

The description of the measure

abbreviations

[ string ]

Yes

The measure abbreviation associations

entity_id

entity_id

No

external_id

external_id

No

code

string

The measure abbreviation

description

string

The description of the measure

abbreviations

[ string ]

The measure abbreviation associations

external_id

external_id

total

integer

items

[ measure ]

code

string

Select the international code of the currency according to ISO 4217

_id

string

The auto-assigned system document identifier

company_id

string

The identifier of the company that owns the document

entity_id

string

The auto-assigned UID of the entity, set on creation. All future versions of the entity share the same entity_id.

is_master

boolean

is_active

boolean

Marking property is the essence of active documents. Sets in true by default.

external_id

string

created_by

string

The identifier of the OPRA user or site that created the document

updated_by

string

The identifier of the OPRA user or site that last updated the document

created_at

string

The last date and time the document was updated

updated_at

string

The last date and time the document was updated