Skip to main content

Branches

EntityDatastoreDatastore.Branch

Branches represent industry sectors or business branches that organisations can be classified under.

Use the Datastore_Branch endpoint to query branches.

Endpoints

List Branches

GET/v1/odata/Datastore_Branch

Single Branche

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

Fields

Datastore Fields (inherited)

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

Relationships

RelationshipTarget EntityCardinalityDescription
OrganizationRelation_Organization1:NOrganization

Expanding Relationships

GET/v1/odata/Datastore_Branch({id})?$expand=Organization
GET/v1/odata/Datastore_Branch({id})/Organization

Filtering Examples

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