1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Opportunities
  4. Orchestration Associations

Get all orchestration associations

get

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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).
  • 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
  • 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:

    • OrchAssocNumberAltKey: Finds an orchestration association based on public unique identifier.
      Finder Variables:
      • OrchestrationAssociationNumber; string; The public unique identifier of an orchestration association.
    • PrimaryKey: Finds an orchestration association with the primary key.
      Finder Variables:
      • OrchestrationAssociationId; integer; The primary key of an orchestration association.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AssociationStatusCode; string; The status of the association.
    • CreationDate; string; The date when the record was created.
    • LastUpdateDate; string; The date when the record was last updated.
    • LastUpdatedBy; string; The user who last updated the record.
    • OrchestrationAssociationId; integer; The unique identifier of the orchestration association.
    • OrchestrationAssociationNumber; string; The alternate identifier of the orchestration association.
    • OrchestrationId; integer; The unique identifier of the orchestration object.
    • OrchestrationNumber; string; The alternate identifier of the orchestration object.
    • SourceObjectCode; string; The language independent object code.
    • SourceObjectId; integer; The unique identifier for the source object code.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : opportunities-OrchestrationAssociations
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : opportunities-OrchestrationAssociations-item-response
Type: object
Show Source
Nested Schema : Error Logs
Type: array
Title: Error Logs
The error logs resource is used to view error logs associated to the orchestration associations.
Show Source
Nested Schema : Stage Objectives
Type: array
Title: Stage Objectives
The stage objectives resource is used to view the stage objectives of the orchestration association.
Show Source
Nested Schema : Stages
Type: array
Title: Stages
The stages resource is used to view the stage of the orchestration association.
Show Source
Nested Schema : Steps
Type: array
Title: Steps
The steps resource is used to view the steps of the orchestration association.
Show Source
Nested Schema : Steps In Execution Path
Type: array
Title: Steps In Execution Path
The steps in execution path resource is used to view all the steps including future steps of the orchestration association.
Show Source
Nested Schema : Step Transitions
Type: array
Title: Step Transitions
The step transitions resource is used to view the step transitions of the orchestration association.
Show Source
Nested Schema : opportunities-OrchestrationAssociations-ErrorLogs-item-response
Type: object
Show Source
Nested Schema : opportunities-OrchestrationAssociations-StageObjectives-item-response
Type: object
Show Source
Nested Schema : opportunities-OrchestrationAssociations-Stages-item-response
Type: object
Show Source
Nested Schema : opportunities-OrchestrationAssociations-Steps-item-response
Type: object
Show Source
Nested Schema : opportunities-OrchestrationAssociations-StepsInExecutionPath-item-response
Type: object
Show Source
Nested Schema : opportunities-OrchestrationAssociations-StepTransitions-item-response
Type: object
Show Source
Links
detachAssociatedOrchestration
Parameters:
  • OptyNumber: $request.path.OptyNumber
This method lets you disassociate the orchestration with the transactional object.
getNotHelpfulObjectiveDetails
Parameters:
  • OptyNumber: $request.path.OptyNumber
This method lets you get the details of objective which aren't helpful.
Back to Top

Examples

The following example shows how to get all orchestration associations of an opportunity by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ 'https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_139534/child/OrchestrationAssociations' -X GET

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "OrchestrationAssociationId": 100105434195464,
            "OrchestrationAssociationNumber": "CDRM_1",
            "SourceObjectCode": "Opportunity",
            "SourceObjectId": 300100588184905,
            "OrchestrationId": 300100588184770,
            "AssociationStatusCode": "COMPLETED",
            "CompletedObjsCnt": 1,
            "SkippedNothelpfulObjsCnt": 3,
            "TotalObjsCnt": 4,
            "PendingObjectivesCount": 0,
            "PerformAction": null,
            "NextStepId": null,
            "NextStepSmartActionId": null,
            "CurrentAssocFlag": true,
            "ActionParameters": null,
            "CreatedBy": "urn_opc_resource_fusion_eemy_sales-common_APPID",
            "CreationDate": "2024-01-09T10:05:18.680+00:00",
            "LastUpdateDate": "2024-01-09T10:07:17.505+00:00",
            "LastUpdatedBy": "urn_opc_resource_fusion_eemy_sales-common_APPID",
            "OrchestrationNumber": "CDRM_2001",
            "OrchestrationName": "SJ_ORCH_01",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_139534/child/OrchestrationAssociations/CDRM_1",
                    "name": "OrchestrationAssociations",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000001778"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_139534/child/OrchestrationAssociations/CDRM_1",
                    "name": "OrchestrationAssociations",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_139534",
                    "name": "opportunities",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_139534/child/OrchestrationAssociations/CDRM_1/lov/PerformActionVA",
                    "name": "PerformActionVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_139534/child/OrchestrationAssociations/CDRM_1/lov/AssociationStatusCodeVA",
                    "name": "AssociationStatusCodeVA",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_139534/child/OrchestrationAssociations/CDRM_1/child/ErrorLogs",
                    "name": "ErrorLogs",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_139534/child/OrchestrationAssociations/CDRM_1/child/StageObjectives",
                    "name": "StageObjectives",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_139534/child/OrchestrationAssociations/CDRM_1/child/Stages",
                    "name": "Stages",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_139534/child/OrchestrationAssociations/CDRM_1/child/StepTransitions",
                    "name": "StepTransitions",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_139534/child/OrchestrationAssociations/CDRM_1/child/Steps",
                    "name": "Steps",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_139534/child/OrchestrationAssociations/CDRM_1/child/StepsInExecutionPath",
                    "name": "StepsInExecutionPath",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_139534/child/OrchestrationAssociations",
            "name": "OrchestrationAssociations",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_139534/child/OrchestrationAssociations/action/detachAssociatedOrchestration",
            "name": "detachAssociatedOrchestration",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_139534/child/OrchestrationAssociations/action/getNotHelpfulObjectiveDetails",
            "name": "getNotHelpfulObjectiveDetails",
            "kind": "other"
        }
    ]
}
Back to Top