Get all orchestration supported objects
get
/crmRestApi/resources/11.13.18.05/orchestrationSupportedObjects
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- ObjectCodeFinder Finds an object with the specified object code.
Finder Variables- ObjectCode; string; The object code of the object being searched.
- OrchSupportedObjectsFinder Finds the objects supporting orchestration.
Finder Variables - PrimaryKey Finds an object with the primary key.
Finder Variables - RelatedObjectsFinder
Finder Variables- bindParentObjectCode; string;
- bindRelatedObjectPropertyCode; string;
- ObjectCodeFinder Finds an object with the specified object code.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- APPStripe; string; The AppStripe value for the object. An AppStripe is the name of the strip containing the keystore for an object.
- AlternateKeys; string; The alternate keys for the object.
- CreatedBy; string; The user who created the row.
- CreationDate; string; The date and time when the row was created.
- Description; string; The description of an object.
- DescriptionResourceId; string; The description of the resource identifier.
- DisplayName; string; The display name of an object.
- DisplayNamePlural; string; The plural title of the object.
- ExtensibleViewDefinition; string; The extensible view object for the object. If VO isn't extensible, then it stores null.
- IsCustomFlag; boolean; Indicates whether the object is a custom object.
- IsExtensible; string; Indicates whether the object is an extensible object.
- KeyAttributes; string; The user keys of an object.
- LabelResourceId; string; The label resource identifier for the object. It will be used to determine the display name for the object.
- LastUpdateDate; string; The date and time when the row was last updated.
- LastUpdatedBy; string; The user who last updated the row.
- ObjectCode; string; The language independent code of the corresponding object in bulk import.
- ObjectDefinition; string; The definition for the object.
- ParentObjectCode; string; The comma separated list of LANG_INDEPENDENT_CODE values used to identify potential parent of object of a current object.
- PluralLabelResourceId; string; The plural label resource identifier of an object.
- PrimaryEntityDefinition; string; The primary entity object definition for the corresponding view object.
- PuidAttribute; string; The public unique identifier of the object.
- RestResource; string; The REST resource code of the object.
- RestResourceIdentifier; string; The REST resource row identifier of the object.
- UcmAccount; string; The UCM folder name where files are uploaded.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : orchestrationSupportedObjects
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : orchestrationSupportedObjects-item-response
Type:
Show Source
object
-
AlternateKeys: string
Title:
Alternate Keys
Read Only:true
The alternate keys for the object. -
APPStripe: string
Title:
Application Stripe
Maximum Length:80
The AppStripe value for the object. An AppStripe is the name of the strip containing the keystore for an object. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
Description: string
Title:
Description
Read Only:true
The description of an object. -
DescriptionResourceId: string
Title:
Description Resource ID
Read Only:true
The description of the resource identifier. -
DisplayName: string
Title:
Display Name
Read Only:true
The display name of an object. -
DisplayNamePlural: string
Title:
Plural Title
Read Only:true
The plural title of the object. -
ExtensibleViewDefinition: string
Title:
Extensible View Definition
Maximum Length:600
The extensible view object for the object. If VO isn't extensible, then it stores null. -
IsCustomFlag: boolean
Title:
Custom Object
Maximum Length:1
Default Value:false
Indicates whether the object is a custom object. -
IsExtensible: string
Title:
Is Extensible
Read Only:true
Indicates whether the object is an extensible object. -
KeyAttributes: string
Title:
User Keys
Read Only:true
The user keys of an object. -
LabelResourceId: string
Title:
Label Resource ID
Maximum Length:700
The label resource identifier for the object. It will be used to determine the display name for the object. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectCode: string
Title:
Object Name
Maximum Length:128
The language independent code of the corresponding object in bulk import. -
ObjectDefinition: string
Title:
Object Definition
Maximum Length:600
The definition for the object. -
ParentObjectCode: string
Title:
Parent Object
Maximum Length:2000
The comma separated list of LANG_INDEPENDENT_CODE values used to identify potential parent of object of a current object. -
PluralLabelResourceId: string
Title:
Plural Label Resource ID
Maximum Length:700
The plural label resource identifier of an object. -
PrimaryEntityDefinition: string
Title:
Primary Entity Definition
Maximum Length:600
The primary entity object definition for the corresponding view object. -
PuidAttribute: string
Title:
Primary Alternate Key
Maximum Length:100
The public unique identifier of the object. -
RestResource: string
Title:
REST Resource Code
Maximum Length:100
The REST resource code of the object. -
RestResourceIdentifier: string
Title:
REST Resource Identifier
Maximum Length:100
The REST resource row identifier of the object. -
UcmAccount: string
Title:
Account
Maximum Length:120
The UCM folder name where files are uploaded.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- generateFindByKeyQuery
-
Operation: /crmRestApi/resources/11.13.18.05/orchestrationSupportedObjects/action/generateFindByKeyQueryReturns object VO query for a specific object and passed attributes.
- generateObjectQuery
-
Operation: /crmRestApi/resources/11.13.18.05/orchestrationSupportedObjects/action/generateObjectQueryThis method returns object VO query for a specific object and passed attributes and filter criteria.
- generateRelatedObjectQuery
-
Operation: /crmRestApi/resources/11.13.18.05/orchestrationSupportedObjects/action/generateRelatedObjectQueryThis method returns the composite object VO query for a specific object, its child, passed attributes, and filter criteria.