1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Orchestrations

Create an orchestration

post

/crmRestApi/resources/11.13.18.05/orchestrations

Request

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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Error Logs
Type: array
Title: Error Logs
The error logs resource is used to view the error details.
Show Source
Nested Schema : Stages
Type: array
Title: Stages
The stages resource is used to view, create, update, and delete an orchestration stage. The stages are a collection of steps, objectives, and associations.
Show Source
Nested Schema : orchestrations-ErrorLogs-item-post-request
Type: object
Show Source
Nested Schema : orchestrations-Stages-item-post-request
Type: object
Show Source
Nested Schema : Stage Objectives
Type: array
Title: Stage Objectives
The stage objectives resource is used to view, create, update, and delete a stage objective. It's a free form of goals to achieve in a particular stage.
Show Source
Nested Schema : Step Objective Associations
Type: array
Title: Step Objective Associations
The step objective associations resource is used to view, create, update, and delete a step objective association. It's the objective of performing a step. One step can be mapped to multiple objectives.
Show Source
Nested Schema : Steps
Type: array
Title: Steps
The steps resource is used to view, create, update, and delete a step. Steps are individual action items such as execute a smart action, send an email, make a phone call, and so on.
Show Source
Nested Schema : Step Tasks
Type: array
Title: Step Tasks
Step tasks contains the list of tasks and their related information for a given step.
Show Source
Nested Schema : orchestrations-Stages-StageObjectives-item-post-request
Type: object
Show Source
Nested Schema : orchestrations-Stages-StepObjectivesAssociations-item-post-request
Type: object
Show Source
Nested Schema : orchestrations-Stages-Steps-item-post-request
Type: object
Show Source
Nested Schema : orchestrations-Stages-StepTasks-item-post-request
Type: object
Show Source
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 : orchestrations-item-response
Type: object
Show Source
Nested Schema : Error Logs
Type: array
Title: Error Logs
The error logs resource is used to view the error details.
Show Source
Nested Schema : Stages
Type: array
Title: Stages
The stages resource is used to view, create, update, and delete an orchestration stage. The stages are a collection of steps, objectives, and associations.
Show Source
Nested Schema : orchestrations-ErrorLogs-item-response
Type: object
Show Source
Nested Schema : orchestrations-Stages-item-response
Type: object
Show Source
Nested Schema : Stage Objectives
Type: array
Title: Stage Objectives
The stage objectives resource is used to view, create, update, and delete a stage objective. It's a free form of goals to achieve in a particular stage.
Show Source
Nested Schema : Step Objective Associations
Type: array
Title: Step Objective Associations
The step objective associations resource is used to view, create, update, and delete a step objective association. It's the objective of performing a step. One step can be mapped to multiple objectives.
Show Source
Nested Schema : Steps
Type: array
Title: Steps
The steps resource is used to view, create, update, and delete a step. Steps are individual action items such as execute a smart action, send an email, make a phone call, and so on.
Show Source
Nested Schema : Step Tasks
Type: array
Title: Step Tasks
Step tasks contains the list of tasks and their related information for a given step.
Show Source
Nested Schema : orchestrations-Stages-StageObjectives-item-response
Type: object
Show Source
Nested Schema : orchestrations-Stages-StepObjectivesAssociations-item-response
Type: object
Show Source
Nested Schema : orchestrations-Stages-Steps-item-response
Type: object
Show Source
Nested Schema : orchestrations-Stages-StepTasks-item-response
Type: object
Show Source
Links
ErrorLogs
Parameters:
  • OrchestrationNumber: $request.path.OrchestrationNumber
The error logs resource is used to view the error details.
OrchestrationSourceObjectsVA
Parameters:
  • finder: OrchSupportedObjectsFinder
The following properties are defined on the LOV link relation:
  • Source Attribute: ObjectCode; Target Attribute: ObjectCode
  • Display Attribute: DisplayName
OrchestrationTypeVA
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_ORCH_DT_TYPE
The following properties are defined on the LOV link relation:
  • Source Attribute: OrchestrationType; Target Attribute: LookupCode
  • Display Attribute: Meaning
PerformActionVA
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_ORCH_PERFORM_ACTION
The following properties are defined on the LOV link relation:
  • Source Attribute: PerformAction; Target Attribute: LookupCode
  • Display Attribute: Meaning
Stages
Parameters:
  • OrchestrationNumber: $request.path.OrchestrationNumber
The stages resource is used to view, create, update, and delete an orchestration stage. The stages are a collection of steps, objectives, and associations.
StatusCodeVA
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_ORCH_DT_STATUS
The following properties are defined on the LOV link relation:
  • Source Attribute: StatusCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
Back to Top

Examples

The following example shows how to create an orchestration by submitting a POST request on the REST resource.

cURL Command

curl -u <username:password> \
 -X POST https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/orchestrations  \
 -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'  | json_pp

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
    "OrchestrationName": "From REST",
    "ObjectCode": "Opportunity",
    "StripingAttributeName": "SalesMethodId",
    "StripingAttributeValue": "300100006785748",
    "LifecycleAttributeName": "SalesStageId",
    "OrchestrationType": "GUIDEDSELLING",
    "StatusCode": "DRAFT",
    "AssociationRank": 9
}

Example of Response Body

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

{
    "OrchestrationId": 300100561261612,
    "OrchestrationNumber": "CDRM_2",
    "OrchestrationName": "From REST",
    "OrchestrationDescription": null,
    "ObjectCode": "Opportunity",
    "StripingAttributeName": "SalesMethodId",
    "StripingAttributeValue": "300100006785748",
    "LifecycleAttributeName": "SalesStageId",
    "OrchestrationType": "GUIDEDSELLING",
    "SourceOrchestrationId": null,
    "StatusCode": "DRAFT",
    "ActivationDateTime": null,
    "AssociationRank": 9,
    "CreationDate": "2022-09-27T07:00:39+00:00",
    "CreatedBy": "SALES_ADMIN",
    "LastUpdatedBy": "SALES_ADMIN",
    "LastUpdateDate": "2022-09-27T07:00:40.735+00:00",
    "DeleteFlag": true,
    "UpdateFlag": true,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/orchestrations/CDRM_2",
            "name": "orchestrations",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/orchestrations/CDRM_2",
            "name": "orchestrations",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/orchestrations/CDRM_2/child/ErrorLogs",
            "name": "ErrorLogs",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/orchestrations/CDRM_2/child/Stages",
            "name": "Stages",
            "kind": "collection"
        },
        {
            "rel": "enclosure",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/orchestrations/CDRM_2/enclosure/AssociationCriteriaExpression",
            "name": "AssociationCriteriaExpression",
            "kind": "other"
        }
    ]
}
Back to Top