ca-orbus-sapi
Relationships
GET - /odata/relationships
Summary:
Gets Relationships and their details.
Description:
Default response includes the list of 50 Relationships, which were most recently created in OrbusInfinity, and their top-level properties.
Use the below OData parameters to filter, order, expand additional properties, and select only specified properties in the output.
Query Parameters
| Name | Type | Description |
|---|---|---|
| $select | string | A subset of properties to include for each Relationship in the response. If left blank, default properties are returned. |
| $expand | string | The additional properties (along with the default ones) to include for each Relationship in the response. You can additionally request the following properties: LeadObject, LeadRelationship, MemberObject, RelationshipType, Model, AttributeValues, AttributeValuesFlat, Detail. |
| $filter | string | The expression you filter the Relationships in the result by. You can filter Relationships by a value for the following properties: RelationshipId, RelationshipTypeId, ModelId, RelationshipType, Model, LeadObjectId, LeadRelationshipId, MemberObjectId, Detail. The minimum and default number of expressions is 0; the maximum—100. |
| $orderby | string | The order in which Relationships are sorted in the response, by a selected property. For example, enter DateCreated desc to request Relationships in descending order by property DateCreated. The minimum and default number of expressions is 0; the maximum—5. |
| $top | integer | The count of the Relationships, which were most recently created in OrbusInfinity, to include in the response. The minimum value is 0; the maximum—50. For example, enter 20 to return 20 Relationships that were most recently created in OrbusInfinity. |
| $skip | integer | The count of the Relationships, which were most recently created in OrbusInfinity, to exclude from the response. The minimum and default value is 0; the maximum—50. For example, enter 20 to skip 20 Relationships that were most recently created in OrbusInfinity and return the next 50. |
| $count | boolean | If true, the total count of Relationships is specified in the response. By default, the parameter is set to false, which means the total count is not returned. |