Get all orchestration associations
get
/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations
Request
Path Parameters
-
OptyNumber(required): string
The unique alternate identifier for the opportunity.
Query Parameters
-
dependency: string
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> -
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:- 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.
- OrchAssocNumberAltKey: Finds an orchestration association based on public unique identifier.
-
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:- 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.
-
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 : opportunities-OrchestrationAssociations
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 : opportunities-OrchestrationAssociations-item-response
Type:
Show Source
object
-
ActionParameters: string
Title:
Action Parameters
Maximum Length:1000
List of parameters required to execute the action specified through PERFORM_ACTION field. -
AssociationStatusCode: string
Title:
Association Status Code
Maximum Length:30
The status of the association. -
CompletedObjsCnt: integer
Title:
Completed Objectives Count
Read Only:true
The count of completed objectives. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CurrentAssocFlag: boolean
Title:
Current Association
Read Only:true
Maximum Length:1
Indicates whether it's the current ACTIVE association or the most recently updated association. -
ErrorLogs: array
Error Logs
Title:
Error Logs
The error logs resource is used to view error logs associated to the orchestration associations. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NextStepId: integer
(int64)
Title:
Next Step ID
Read Only:true
The unique identifier of the next step to be executed as part of the current Orchestration. -
NextStepSmartActionId: integer
(int64)
Title:
Next Step Smart Action ID
Read Only:true
The smart action identifier of the next step to be executed as part of the current Orchestration. -
OrchestrationAssociationId: integer
(int64)
Title:
Orchestration Association ID
The unique identifier of the orchestration association. -
OrchestrationAssociationNumber: string
Title:
Orchestration Association Number
Maximum Length:64
The alternate identifier of the orchestration association. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier of the orchestration object. -
OrchestrationName: string
Title:
Orchestration Name
Read Only:true
Maximum Length:100
The name of orchestration object. -
OrchestrationNumber: string
Title:
Orchestration Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration object. -
PendingObjectivesCount: integer
Title:
Pending Objectives Count
Read Only:true
Number of pending objectives. -
PerformAction: string
Title:
Action to Perform
Maximum Length:30
The action that user can perform on this orchestration association. -
SkippedNothelpfulObjsCnt: integer
Title:
Skipped Objectives Count
Read Only:true
The count of skipped or not helpful objectives. -
SourceObjectCode: string
Title:
Source Object Code
Maximum Length:100
The language independent object code. -
SourceObjectId: integer
(int64)
Title:
Source Object ID
The unique identifier for the source object code. -
StageObjectives: array
Stage Objectives
Title:
Stage Objectives
The stage objectives resource is used to view the stage objectives of the orchestration association. -
Stages: array
Stages
Title:
Stages
The stages resource is used to view the stage of the orchestration association. -
Steps: array
Steps
Title:
Steps
The steps resource is used to view the steps of the orchestration association. -
StepsInExecutionPath: array
Steps In Execution Path
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. -
StepTransitions: array
Step Transitions
Title:
Step Transitions
The step transitions resource is used to view the step transitions of the orchestration association. -
TotalObjsCnt: integer
Title:
Total Objectives Count
Read Only:true
The total number of objectives.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
ErrorDescription: string
(byte)
Title:
Error Description
The description of the error. -
ErrorLogsId: integer
(int64)
Title:
Error Logs ID
The unique identifier of the orchestration error logs. -
ErrorLogsNumber: string
Title:
Error Logs Number
Maximum Length:64
The alternate identifier of the orchestration error logs. -
ErrorText: string
Title:
Error Text
Maximum Length:2000
The brief error details. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrchestrationAssociationId: integer
(int64)
Title:
Orchestration Association ID
The unique identifier of the orchestration association. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier of the orchestration object. -
OrchestrationName: string
Title:
Orchestration Name
Read Only:true
Maximum Length:100
The name of orchestration object. -
OrchestrationNumber: string
Title:
Orchestration Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration object. -
OrchestrationStageId: integer
(int64)
Title:
Orchestration Stage ID
The unique identifier of the orchestration stage object. -
OrchestrationStageName: string
Title:
Stage Name
Read Only:true
Maximum Length:100
The name of orchestration stage object. -
OrchestrationStageNumber: string
Title:
Orchestration Stage Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration stage object. -
OrchestrationStepId: integer
(int64)
Title:
Orchestration Step ID
The unique identifier of the orchestration step object. -
OrchestrationStepName: string
Title:
Orchestration Step Name
Read Only:true
Maximum Length:100
The name of orchestration step. -
OrchestrationStepNumber: string
Title:
Orchestration Step Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration step object. -
SourceObjectCode: string
Title:
Source Object Code
Maximum Length:100
The language independent object code. -
SourceObjectId: integer
(int64)
Title:
Source Object ID
The unique identifier for the source object code.
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.
Nested Schema : opportunities-OrchestrationAssociations-StageObjectives-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DisplaySequence: integer
Title:
Display Sequence
The order in which the stages are to be executed or shown back in UI. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrchestrationAssociationId: integer
(int64)
Title:
Orchestration Association ID
The unique identifier of the orchestration association. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier of the orchestration object. -
OrchestrationName: string
Title:
Orchestration Name
Read Only:true
Maximum Length:100
The name of orchestration object. -
OrchestrationNumber: string
Title:
Orchestration Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration object. -
OrchestrationStageDisplaySequence: integer
(int32)
Title:
Display Sequence
Read Only:true
The order of the stages in the orchestration admin run time UIs. -
OrchestrationStageId: integer
(int64)
Title:
Orchestration Stage ID
The unique identifier of the orchestration stage object. -
OrchestrationStageName: string
Title:
Stage Name
Read Only:true
Maximum Length:100
The name of the orchestration stage object. -
OrchestrationStageObjDescription: string
Title:
Objective Description
Read Only:true
Maximum Length:2000
The description text of the orchestration stage objective object. -
OrchestrationStageObjDisplaySequence: integer
(int32)
Title:
Display Sequence
Read Only:true
The order of the stages in the orchestration admin run time UIs. -
OrchestrationStageObjectiveId: integer
(int64)
Title:
Stage Objective ID
The unique identifier of the orchestration stage objective object. -
OrchestrationStageObjName: string
Title:
Objective Name
Read Only:true
Maximum Length:100
The name of the orchestration stage objective object. -
OrchestrationStageObjNumber: string
Title:
Stage Objective Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration stage objective object. -
RunTimeStageObjectiveId: integer
(int64)
Title:
Run Time Stage Objective ID
The unique identifier of the orchestration stage objective object. -
RunTimeStageObjectiveNumber: string
Title:
Run Time Stage Objective Number
Maximum Length:64
The alternate identifier of the orchestration stage objective object. -
RunTimeStatus: string
Title:
Run Time Status
Maximum Length:30
The status of the orchestration stage objective transition.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-OrchestrationAssociations-Stages-item-response
Type:
Show Source
object
-
CompletedObjsCnt: integer
Title:
Completed Objectives Count
The count of completed objectives. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CurrentStageFlag: boolean
Title:
Current Stage
Maximum Length:1
Indicates whether it's the current INPROGRESS stage or the most recently updated stage. -
DisplaySequence: integer
Title:
Display Sequence
The order in which the stage objectives are to be executed or shown back in UI. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrchestrationAssociationId: integer
(int64)
Title:
Orchestration Association ID
The unique identifier of the orchestration association. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier of the orchestration object. -
OrchestrationName: string
Title:
Orchestration Name
Read Only:true
Maximum Length:100
The name of orchestration object. -
OrchestrationNumber: string
Title:
Orchestration Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration object. -
OrchestrationStageDescription: string
Title:
Objective Description
Read Only:true
Maximum Length:2000
The description text of the orchestration stage object. -
OrchestrationStageId: integer
(int64)
Title:
Orchestration Stage ID
The unique identifier of the orchestration stage object. -
OrchestrationStageName: string
Title:
Stage Name
Read Only:true
Maximum Length:100
The name of the orchestration stage object. -
OrchestrationStageNumber: string
Title:
Orchestration Stage Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration stage object. -
PendingObjectivesCount: integer
Title:
Pending Objectives Count
Number of pending objectives. -
RuntimeStageId: integer
(int64)
Title:
Run Time Stage ID
The unique identifier of the orchestration stages runtime object. -
RuntimeStageNumber: string
Title:
Run Time Stage Number
Maximum Length:64
The alternate identifier of the orchestration stages runtime object. -
RunTimeStatus: string
Title:
Run Time Status
Maximum Length:30
The status of the orchestration stages. -
SkippedNothelpfulObjsCnt: integer
Title:
Skipped Objectives Count
The count of skipped or not helpful objectives. -
StageEndDate: string
(date-time)
Title:
Stage End Date
The date and time when the stage execution starts. -
StageStartDate: string
(date-time)
Title:
Stage Start Date
The date and time when the stage execution ends. -
StepsCountInExecutionPath: integer
Title:
Step Count in Execution Path
Read Only:true
Number of Steps in the execution path for the orchestration stage. -
TotalObjsCnt: integer
Title:
Total Objectives Count
The total number of objectives.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-OrchestrationAssociations-Steps-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CurrentStepFlag: boolean
Title:
Current Step
Maximum Length:1
Indicates whether it's the current INPROGRESS step or the most recently updated step. -
DisplaySequence: integer
Title:
Display Sequence
The order in which the steps are to be executed or shown back in UI. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrchestrationAssociationId: integer
(int64)
Title:
Orchestration Association ID
The unique identifier of the orchestration association. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier of the orchestration object. -
OrchestrationName: string
Title:
Orchestration Name
Read Only:true
Maximum Length:100
The name of orchestration object. -
OrchestrationNumber: string
Title:
Orchestration Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration object. -
OrchestrationStageId: integer
(int64)
Title:
Orchestration Stage ID
The unique identifier of the orchestration stage object. -
OrchestrationStageName: string
Title:
Stage Name
Read Only:true
Maximum Length:100
The name of the orchestration stage object. -
OrchestrationStageNumber: string
Title:
Orchestration Stage Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration stage object. -
OrchestrationStepId: integer
(int64)
Title:
Orchestration Step ID
The unique identifier of the orchestration step object. -
OrchestrationStepName: string
Title:
Orchestration Step Name
Read Only:true
Maximum Length:100
The name of orchestration step. -
OrchestrationStepNumber: string
Title:
Orchestration Step Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration step object. -
RunTimeStatus: string
Title:
Run Time Status
Maximum Length:30
The run time status of the orchestration stage objective transition. -
RunTimeStepId: integer
(int64)
Title:
Run Time Step ID
The unique identifier of the orchestration steps runtime object. -
RunTimeStepNumber: string
Title:
Run Time Step Number
Maximum Length:64
The alternate identifier of the orchestration steps runtime object. -
StepEndDate: string
(date-time)
Title:
Step End Date
The date and time when the step execution ends. -
StepStartDate: string
(date-time)
Title:
Step Start Date
The date and time when the step execution starts.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-OrchestrationAssociations-StepsInExecutionPath-item-response
Type:
Show Source
object
-
ContainMultipleTasks: string
Read Only:
true
Maximum Length:1
Indicates whether the step contains multiple tasks. -
CurrentStepFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether it's the current INPROGRESS step or the most recently updated step. -
DisplaySequence: integer
(int32)
Read Only:
true
The order of the steps in the orchestration administrator runtime UIs. -
ExecutionMethod: string
Read Only:
true
Maximum Length:30
The execution type for the orchestration step. The possible values are Manual and Automatic. -
FulfillsObjectiveCnt: integer
Read Only:
true
The count of objectives. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrchestrationAssocId: integer
(int64)
Read Only:
true
The unique identifier of the orchestration association. -
OrchestrationStageId: integer
(int64)
Read Only:
true
The unique identifier of the orchestration stage object. -
OrchestrationStageObjId: integer
(int64)
Read Only:
true
The unique identifier of the orchestration stage objective object. -
OrchestrationStepId: integer
(int64)
Read Only:
true
The unique identifier of the orchestration step object. -
OrchestrationStepName: string
Read Only:
true
Maximum Length:100
The name of orchestration step. -
RunTimeStatus: string
Read Only:
true
Maximum Length:30
The runtime status of the orchestration steps. -
StepEndDate: string
(date-time)
Read Only:
true
Specifies the date and time when the step execution ends. -
StepStartDate: string
(date-time)
Read Only:
true
Specifies the date and time when the step execution starts. -
StepSuggestionText: string
Read Only:
true
Maximum Length:2000
Suggestion text of the Orchestration step. -
StepType: string
Read Only:
true
Maximum Length:30
The type of step.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : opportunities-OrchestrationAssociations-StepTransitions-item-response
Type:
Show Source
object
-
ActivityAppointmentStatusCode: string
Title:
Appointment Status
Read Only:true
Maximum Length:30
Denotes the status of the Appointment. -
ActivityDescription: string
(byte)
Title:
Description
Read Only:true
A text field for capturing some descriptive information about the activity. -
ActivityDueDate: string
(date)
Title:
Due Date
Read Only:true
The date the task activity is due to be completed. -
ActivityEndDate: string
(date-time)
Title:
End Date
Read Only:true
The end date and time of an appointment, or the completion time of a task. -
ActivityId: integer
(int64)
Title:
Activity ID
The unique identifier of the activity. -
ActivityNumber: string
Title:
Activity Number
Read Only:true
Maximum Length:64
Alternate identifier of the activity. System generated or can come from external system (user key). -
ActivityOwnerId: integer
(int64)
Title:
Owner ID
Read Only:true
The primary resource on the activity. Supports resources only. -
ActivityOwnerPartyName: string
Title:
Owner
Read Only:true
Maximum Length:360
Name of the party. -
ActivityPartialDescription: string
Title:
Short Description
Read Only:true
Maximum Length:4000
A column that stores the first 4000 characters of activity description. -
ActivitySMARTActionContext: string
Title:
Smart Action Context
Read Only:true
Maximum Length:4000
Stores metadata needed for smart action -
ActivitySMARTActionId: integer
(int64)
Title:
Smart Action ID
Read Only:true
Smart action identifier. Foriegn key from zca_user_action. -
ActivityStartDate: string
(date-time)
Title:
Start Date
Read Only:true
The start date and time of an appointment or a task. Defaulted to null for an appointment and defaulted to creation datetime for a task. -
ActivitySubject: string
Title:
Subject
Read Only:true
Maximum Length:500
Subject or name ot title of the activity. -
ActivityTaskStatusCode: string
Title:
Status
Read Only:true
Maximum Length:30
Status of the activity. Defaulted to NOT_STARTED. -
ActivityWebConferenceId: string
Title:
Web Conference ID
Read Only:true
Maximum Length:255
The unique identifier of the web conference. -
ActivityWebConferenceURL: string
Title:
Web Conference URL
Read Only:true
Maximum Length:2000
The web conference join URL. -
AllowSkipFlag: boolean
Title:
Allow Step Skipping
Read Only:true
Maximum Length:1
Default Value:true
Indicates whether or not to show skip or thumbs down icon in guidance primary or secondary banner. -
Comments: string
Title:
Comments
Maximum Length:2000
Specifies the brief comments required for runtime step transition row. -
ConversationId: integer
(int64)
Title:
Conversation ID
The unique identifier of conversation message. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
EmailType: string
Title:
Email Type
Maximum Length:30
The orchestration step transition runtime email type. -
ExitOrchestrationFlag: boolean
Title:
Exit Orchestration
Read Only:true
Maximum Length:1
Indicates whether or not to exit the orchestration when stop step occurs. -
InboundConvMsgId: integer
(int64)
Title:
Inbound Conversation Message ID
The unique identifier of inbound conversation message. -
InteractionId: integer
(int64)
Title:
Interaction ID
The unique identifier of interaction. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrchestrationAssociationId: integer
(int64)
Title:
Orchestration Association ID
The unique identifier of the orchestration association. -
OrchestrationAssociationNumber: string
Title:
Orchestration Association Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration association. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier of the orchestration object. -
OrchestrationName: string
Title:
Orchestration Name
Read Only:true
Maximum Length:100
The name of orchestration object. -
OrchestrationNumber: string
Title:
Orchestration Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration object. -
OrchestrationStageId: integer
(int64)
Title:
Orchestration Stage ID
The unique identifier of the orchestration stage object. -
OrchestrationStageName: string
Title:
Stage Name
Read Only:true
Maximum Length:100
The name of the orchestration stage object. -
OrchestrationStageNumber: string
Title:
Orchestration Stage Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration stage object. -
OrchestrationStepId: integer
(int64)
Title:
Orchestration Step ID
The unique identifier of the orchestration step object. -
OrchestrationStepName: string
Title:
Orchestration Step Name
Read Only:true
Maximum Length:100
The name of orchestration step. -
OrchestrationStepNumber: string
Title:
Orchestration Step Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration step object. -
OrchestrationStepTasksId: integer
(int64)
Title:
Orchestration Step Tasks ID
Unique identifier for the orchestration step tasks. -
OrchestrationStepType: string
Title:
Step Type
Read Only:true
Maximum Length:30
The type of step. -
OrchStepTransitionFlag: boolean
Title:
Current Step Transition
Maximum Length:1
Indicates whether it's the current INPROGRESS Step transition or the most recently updated step transition row. -
OutboundConvMsgId: integer
(int64)
Title:
Outbound Conversation Message ID
The unique identifier of outbound conversation message. -
RefreshPageFlag: boolean
Title:
Refresh Page
Maximum Length:1
Indicates whether or not to refresh the whole page before surfacing the current Step in the runtime UI. -
StepDisplaySequence: integer
Title:
Display Sequence
Read Only:true
The order of the steps in the orchestration administrator runtime UIs. -
StepSuggestionText: string
Title:
Step Suggestion Text
Read Only:true
Maximum Length:2000
Suggestion text of the Orchestration step. -
StepTaskDisplaySequence: integer
(int32)
Title:
Display Sequence
Read Only:true
The order of the steps in the orchestration administrator runtime UIs. -
StepTransitionId: integer
(int64)
Title:
Step Transition ID
The unique identifier of the orchestration step transition object. -
StepTransitionNumber: string
Title:
Step Transition Number
Maximum Length:64
The alternate identifier of the orchestration step transition object. -
StepType: string
Title:
Step Type
Maximum Length:30
The type of the step to which the step transitions correspond to. -
SuccessCriteriaEvalFlag: boolean
Title:
Success Criteria Evaluation Flag
Maximum Length:1
Specifies the success criteria evaluation result for the step. -
TransitionDueDateTime: string
(date-time)
Title:
Transition Due Date Time
The date and time when the step transition is due. -
TransitionEndDateTime: string
(date-time)
Title:
Transition End Date Time
The date and time when the step transition ended. -
TransitionStartDateTime: string
(date-time)
Title:
Transition Start Date Time
The date and time when the step transition started. -
TransitionStatus: string
Title:
Transition Status
Maximum Length:30
The status of the orchestration step transition. -
WrapUpId: integer
(int64)
Title:
Wrap-up ID
The unique identifier of the wrap up.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- detachAssociatedOrchestration
-
Parameters:
- OptyNumber:
$request.path.OptyNumber
This method lets you disassociate the orchestration with the transactional object. - OptyNumber:
- getNotHelpfulObjectiveDetails
-
Parameters:
- OptyNumber:
$request.path.OptyNumber
This method lets you get the details of objective which aren't helpful. - OptyNumber: