Statuses
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_StatusSingle Statuse
GET
/v1/odata/Datastore_Status({id})Fields
Datastore Fields (inherited)
| Field | Type | Description |
|---|---|---|
Name | String | Display name |
Code | String | Unique code identifier |
LocalizedName | String | Localized display name |
IsDefault | Boolean | Whether this is the default value |
Relationships
| Relationship | Target Entity | Cardinality | Description |
|---|---|---|---|
| CommercialRelation | Relationship_Organization_CommercialRelationship | 1:N | CommercialRelation |
| CommercialRelationship | Relationship_Person_CommercialRelationship | 1:N | CommercialRelationship |
Expanding Relationships
GET
/v1/odata/Datastore_Status({id})?$expand=CommercialRelationNavigating Relationships
GET
/v1/odata/Datastore_Status({id})/CommercialRelationFiltering 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}