ca-orbus-sapi

1.0.x
(0 reviews)

Objects

GET - /odata/objects

Summary:

Gets Objects and their details.

Description:

Default response includes the list of 50 Objects, 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

NameTypeDescription
$selectstringA subset of properties to include for each Object in the response. If left blank, default properties are returned.
$expandstringThe additional properties (along with the default ones) to include for each Object in the response. You can additionally request the following properties: Model, ObjectType, AttributeValues, AttributeValuesFlat, CreatedBy, LastModifiedBy, LockedBy, Detail.
$filterstringThe expression you filter the Objects in the result by. You can filter Objects by a value for the following properties: ObjectId, Name, ObjectTypeId, LockedOn, LockedById, IsApproved, ModelId, DateCreated, CreatedById, LastModifiedDate, LastModifiedById, Detail, AttributeValues, ObjectType, Model, CreatedBy, LastModifiedBy, LockedBy. The minimum and default number of expressions is 0; the maximum—100
$orderbystringThe order in which Objects are sorted in the response, by a selected property. For example, enter Name desc to request Objects in descending order by property Name. The minimum and default number of expressions is 0; the maximum—5.
$topintegerThe count of the Objects, 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 Objects that were most recently created in OrbusInfinity.
$skipintegerThe count of the Objects, 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 Objects that were most recently created in OrbusInfinity and return the next 50.
$countbooleanIf true, the total count of Objects is specified in the response. By default, the parameter is set to false, which means the total count is not returned.

POST - /odata/objects

Summary:

Creates a new Object.

Description:

You must specify Object Type ID, Model ID, and Identifying Attribute(s) for the new Object. Use AttributeValuesFlat property to specify Attribute values in the key-value format.

Body

Description:

Property values for a new Object. Specify ObjectTypeId, ModelId, Name to create an Object.

Optionally specify additional properties, following the structure in the example.

Default value : OrderedMap { "ObjectTypeId": "8404383b-0eab-4f8c-9199-030d0032028a", "ModelId": "04ae378f-c8e6-4522-9a42-363269d10f17", "AttributeValuesFlat": OrderedMap { "Name": "Evaluate options", "Description": "Evaluate options" } }

Example

{
  "ObjectTypeId": "8404383b-0eab-4f8c-9199-030d0032028a",
  "ModelId": "04ae378f-c8e6-4522-9a42-363269d10f17",
  "AttributeValuesFlat": {
    "Name": "Evaluate options",
    "Description": "Evaluate options"
  }
}

PATCH - /odata/objects/{key}

Updates Attribute values of an existing Object.

Description:

Use AttributeValuesFlat property to specify Attribute values in the key-value format. Only specified Attribute values will be updated.

Parameters

NameTypeDescription
keystringID of an Object in the GUID format, for example 00000000-0000-0000-0000-000000000000.
bodyobjectAttribute value(s) to update for the specified Object. For each Attribute, specify AttributeName, AttributeCategory, and TextValue. Default value : OrderedMap { "AttributeValuesFlat": OrderedMap { "Name": "Evaluate options", "CostKey": 200.45, "LinksKey": List [ OrderedMap { "Url": "www.example.com", "DisplayValue": "Example Link" } ], "ChoicesKey": List [ OrderedMap { "AttributeConfigurationChoiceId": "33d3e533-f657-438c-a971-a65bb6dc1fa6", "Children": List [] } ] } }

Example

{
  "AttributeValuesFlat": {
    "Name": "Evaluate options",
    "CostKey": 200.45,
    "LinksKey": [
      {
        "Url": "www.example.com",
        "DisplayValue": "Example Link"
      }
    ],
    "ChoicesKey": [
      {
        "AttributeConfigurationChoiceId": "33d3e533-f657-438c-a971-a65bb6dc1fa6",
        "Children": []
      }
    ]
  }
}

Reviews