Skip to main content

Statuses

Entity›Datastore›Datastore.Status

Statuses define the status of commercial relationships for tracking relationship health.

Use the Datastore_Status endpoint to query statuses.

Endpoints​

List Statuses​

GET/v1/odata/Datastore_Status

Single Statuse​

GET/v1/odata/Datastore_Status({id})

Fields​

Datastore Fields (inherited)​

FieldTypeDescription
NameStringDisplay name
CodeStringUnique code identifier
LocalizedNameStringLocalized display name
IsDefaultBooleanWhether this is the default value

Relationships​

RelationshipTarget EntityCardinalityDescription
CommercialRelationRelationship_Organization_CommercialRelationship1:NCommercialRelation
CommercialRelationshipRelationship_Person_CommercialRelationship1:NCommercialRelationship

Expanding Relationships​

GET/v1/odata/Datastore_Status({id})?$expand=CommercialRelation
GET/v1/odata/Datastore_Status({id})/CommercialRelation

Filtering Examples​

GET/v1/odata/Datastore_Status?$filter=Name eq '{Name}'&$top={top}
GET/v1/odata/Datastore_Status?$filter=contains(Name, '{Name}')&$top={top}
GET/v1/odata/Datastore_Status?$filter=Code eq '{Code}'&$top={top}
GET/v1/odata/Datastore_Status?$filter=IsDefault eq {IsDefault}&$top={top}

Custom Query​

Build your own OData query against Datastore_Status. Open Run and edit the whole request inline — swap the entity set, change the $filter, or add $expand, $select, $orderby, $top, $skip. Type $ for suggestions; use ↺ Reset to restore this example.

GET/v1/odata/Datastore_Status?$top=10