Skip to main content

Involved Roles

Entity›Datastore›Datastore.InvolvedRole

Involved roles define the roles that parties can play in activities (e.g., decision maker, influencer, end user).

Use the Datastore_InvolvedRole endpoint to query involved roles.

Endpoints​

List Involved Roles​

GET/v1/odata/Datastore_InvolvedRole

Single Involved Role​

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

Fields​

Datastore Fields (inherited)​

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

Relationships​

RelationshipTarget EntityCardinalityDescription
InvolvedInvolved1:NInvolved

Expanding Relationships​

GET/v1/odata/Datastore_InvolvedRole({id})?$expand=Involved
GET/v1/odata/Datastore_InvolvedRole({id})/Involved

Filtering Examples​

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

Custom Query​

Build your own OData query against Datastore_InvolvedRole. 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_InvolvedRole?$top=10