Jump to

• Request
• Response

Update a step task

patch

/crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StepTasks/{StepTasksNumber}

Request

Path Parameters

• OrchestrationNumber(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• OrchestrationStageNumber(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• StepTasksNumber(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AllowSkipFlag: boolean
  Title: Allow Step Skipping

  Maximum Length: 1

  Default Value: true

  Indicates whether or not to show skip or thumbs down icon in the guidance primary or secondary banner.
• AssignedTo: string
  Title: Assigned To

  Maximum Length: 30

  Default Value: OWNER

  Indicates to whom the activity should be assigned to when it's generated. Possible values are OWNER, TEAM MEMBER, and CUSTOM CONDITION.
• AssignedToRule: string (byte)
  Title: Assigned to Rule

  The rule when AssignedTo is specified as CUSTOM_CONDITION.
• DisplaySequence: integer (int32)
  Title: Display Sequence

  The order of the steps in the orchestration administrator runtime UIs.
• EmailTemplateId: integer (int64)
  Title: Email Template ID

  The unique identifier of the email template that will be defaulted at run time.
• EvaluateOnMarkCompleteFlag: boolean
  Title: Evaluate on Marked as Completed

  Maximum Length: 1

  Default Value: false

  Indicates whether or not to evaluate the success criteria when a task or an appointment is marked as complete.
• FieldUpdateJson: string (byte)
  Title: Field Update JSON

  The JSON structure containing the list of fields to update on source object.
• GracePeriod: integer
  Title: Grace Period

  Specifies the number of hours to wait before treating the Step as failed. This is applicable only for manual steps.
• IATemplateValue: string
  Title: IA Template Value

  Maximum Length: 100

  The name of the intelligent advisor guide template.
• SMARTActionId: integer (int64)
  Title: Smart Action ID

  The unique identifier of the smart action.
• WaitForRepliesFlag: boolean
  Title: Wait for Replies Flag

  Maximum Length: 1

  Default Value: false

  Indicates whether the step has to wait for replies.

{
    "type":"object",
    "properties":{
        "AssignedTo":{
            "title":"Assigned To",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates to whom the activity should be assigned to when it's generated. Possible values are OWNER, TEAM MEMBER, and CUSTOM CONDITION.",
            "nullable":true,
            "default":"OWNER",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "IATemplateValue":{
            "title":"IA Template Value",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the intelligent advisor guide template.",
            "nullable":true,
            "x-queryable":false
        },
        "FieldUpdateJson":{
            "title":"Field Update JSON",
            "type":"string",
            "description":"The JSON structure containing the list of fields to update on source object.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SMARTActionId":{
            "title":"Smart Action ID",
            "type":"integer",
            "description":"The unique identifier of the smart action.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order of the steps in the orchestration administrator runtime UIs.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "EvaluateOnMarkCompleteFlag":{
            "title":"Evaluate on Marked as Completed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether or not to evaluate the success criteria when a task or an appointment is marked as complete.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "WaitForRepliesFlag":{
            "title":"Wait for Replies Flag",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the step has to wait for replies.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "EmailTemplateId":{
            "title":"Email Template ID",
            "type":"integer",
            "description":"The unique identifier of the email template that will be defaulted at run time.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AllowSkipFlag":{
            "title":"Allow Step Skipping",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether or not to show skip or thumbs down icon in the guidance primary or secondary banner.",
            "nullable":true,
            "default":true,
            "x-queryable":false
        },
        "GracePeriod":{
            "title":"Grace Period",
            "type":"integer",
            "description":"Specifies the number of hours to wait before treating the Step as failed. This is applicable only for manual steps.",
            "nullable":true,
            "x-queryable":false
        },
        "AssignedToRule":{
            "title":"Assigned to Rule",
            "type":"string",
            "description":"The rule when AssignedTo is specified as CUSTOM_CONDITION.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

Response

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.

Body ()

Root Schema : orchestrations-Stages-StepTasks-item-response

Type: object

Show Source

• ActivityId: integer (int64)
  Title: Activity ID

  The unique identifier of the activity ID.
• ActivityTemplateId: integer (int64)
  Title: Activity Template ID

  The identifier for the Task and Appointment templates.
• AllowSkipFlag: boolean
  Title: Allow Step Skipping

  Maximum Length: 1

  Default Value: true

  Indicates whether or not to show skip or thumbs down icon in the guidance primary or secondary banner.
• AssignedTo: string
  Title: Assigned To

  Maximum Length: 30

  Default Value: OWNER

  Indicates to whom the activity should be assigned to when it's generated. Possible values are OWNER, TEAM MEMBER, and CUSTOM CONDITION.
• AssignedToRule: string (byte)
  Title: Assigned to Rule

  The rule when AssignedTo is specified as CUSTOM_CONDITION.
• 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.
• DisplaySequence: integer (int32)
  Title: Display Sequence

  The order of the steps in the orchestration administrator runtime UIs.
• EmailTemplateId: integer (int64)
  Title: Email Template ID

  The unique identifier of the email template that will be defaulted at run time.
• EvaluateOnMarkCompleteFlag: boolean
  Title: Evaluate on Marked as Completed

  Maximum Length: 1

  Default Value: false

  Indicates whether or not to evaluate the success criteria when a task or an appointment is marked as complete.
• FieldUpdateJson: string (byte)
  Title: Field Update JSON

  The JSON structure containing the list of fields to update on source object.
• GracePeriod: integer
  Title: Grace Period

  Specifies the number of hours to wait before treating the Step as failed. This is applicable only for manual steps.
• IATemplateValue: string
  Title: IA Template Value

  Maximum Length: 100

  The name of the intelligent advisor guide template.
• LastUpdateDate: string (date-time)
  Title: Last Updated 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.
• OrchestrationStageId: integer (int64)
  Title: Orchestration Stage ID

  The unique identifier of the orchestrations stage object.
• OrchestrationStageName: string
  Title: Stage Name

  Read Only: true

  Maximum Length: 100

  The unique identifier of the orchestrations stage object.
• OrchestrationStageNumber: string
  Title: Orchestration Stage Number

  Read Only: true

  Maximum Length: 64

  The name of the orchestration stage.
• OrchestrationStepId: integer (int64)
  Title: Orchestration Step ID

  The unique identifier of the orchestration steps object.
• OrchestrationStepName: string
  Title: Orchestration Step Name

  Read Only: true

  Maximum Length: 100

  The name of orchestration step.
• OrchestrationStepNumber: string
  Title: Orchestration Step Number

  Maximum Length: 64

  The public unique identifier of the orchestration steps object.
• OrchestrationStepTaskDescription: string (byte)
  Title: Orchestration Step Task Description

  Read Only: true

  The description of the orchestration step task.
• OrchestrationStepTaskName: string
  Title: Orchestration Step Task Name

  Read Only: true

  Maximum Length: 500

  The name of the orchestration step task.
• SMARTActionId: integer (int64)
  Title: Smart Action ID

  The unique identifier of the smart action.
• StepTasksId: integer (int64)
  Title: Orchestration Step Tasks ID

  The unique identifier of the orchestration step tasks object.
• StepTasksNumber: string
  Title: Orchestration Step Tasks Number

  Maximum Length: 64

  The public unique identifier of the orchestration step tasks object.
• WaitForRepliesFlag: boolean
  Title: Wait for Replies Flag

  Maximum Length: 1

  Default Value: false

  Indicates whether the step has to wait for replies.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order of the steps in the orchestration administrator runtime UIs.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"The unique identifier of the activity ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrchestrationStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration steps object.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EmailTemplateId":{
            "title":"Email Template ID",
            "type":"integer",
            "description":"The unique identifier of the email template that will be defaulted at run time.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier of the orchestrations stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldUpdateJson":{
            "title":"Field Update JSON",
            "type":"string",
            "description":"The JSON structure containing the list of fields to update on source object.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestrations stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EvaluateOnMarkCompleteFlag":{
            "title":"Evaluate on Marked as Completed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether or not to evaluate the success criteria when a task or an appointment is marked as complete.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrchestrationStepTaskName":{
            "title":"Orchestration Step Task Name",
            "maxLength":"500",
            "type":"string",
            "description":"The name of the orchestration step task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"ActivityEO.Subject",
                "protectionState":"TOKENIZED"
            },
            "x-queryable":true
        },
        "StepTasksNumber":{
            "title":"Orchestration Step Tasks Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration step tasks object.",
            "nullable":false,
            "x-queryable":true
        },
        "AllowSkipFlag":{
            "title":"Allow Step Skipping",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether or not to show skip or thumbs down icon in the guidance primary or secondary banner.",
            "nullable":true,
            "default":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IATemplateValue":{
            "title":"IA Template Value",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the intelligent advisor guide template.",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the orchestration stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SMARTActionId":{
            "title":"Smart Action ID",
            "type":"integer",
            "description":"The unique identifier of the smart action.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration steps object.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ActivityTemplateId":{
            "title":"Activity Template ID",
            "type":"integer",
            "description":"The identifier for the Task and Appointment templates.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WaitForRepliesFlag":{
            "title":"Wait for Replies Flag",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the step has to wait for replies.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "OrchestrationStepName":{
            "title":"Orchestration Step Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedTo":{
            "title":"Assigned To",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates to whom the activity should be assigned to when it's generated. Possible values are OWNER, TEAM MEMBER, and CUSTOM CONDITION.",
            "nullable":true,
            "default":"OWNER",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrchestrationStepTaskDescription":{
            "title":"Orchestration Step Task Description",
            "type":"string",
            "description":"The description of the orchestration step task.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"ActivityEO.ActivityDesc",
                "protectionState":"TOKENIZED"
            },
            "x-queryable":true
        },
        "StepTasksId":{
            "title":"Orchestration Step Tasks ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step tasks object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GracePeriod":{
            "title":"Grace Period",
            "type":"integer",
            "description":"Specifies the number of hours to wait before treating the Step as failed. This is applicable only for manual steps.",
            "nullable":true,
            "x-queryable":false
        },
        "AssignedToRule":{
            "title":"Assigned to Rule",
            "type":"string",
            "description":"The rule when AssignedTo is specified as CUSTOM_CONDITION.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

AssignedToVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_ORCH_DT_TASK_ASSIGNEE

The following properties are defined on the LOV link relation:

• Source Attribute: AssignedTo; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top