Update an orchestration stage objective
patch
/crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StageObjectives/{StageObjectiveNumber}
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=
-
StageObjectiveNumber(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
Root Schema : schema
Type:
Show Source
object
-
DisplaySequence: integer
(int32)
Title:
Display Sequence
The order of the objectives in the orchestration administrator runtime user interface. -
ObjectiveDescription: string
Title:
Objective Description
Maximum Length:2000
The description text of the orchestration stage objective object. -
ObjectiveName: string
Title:
Objective Name
Maximum Length:100
The name of the orchestration stage objective object. -
ObjectiveStatus: string
Title:
Objective Status
Maximum Length:30
The status of the objective. Possible values are NEW or MAPPED.
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.
Root Schema : orchestrations-Stages-StageObjectives-item-response
Type:
Show Source
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. -
DisplaySequence: integer
(int32)
Title:
Display Sequence
The order of the objectives in the orchestration administrator runtime user interface. -
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. -
ObjectiveDescription: string
Title:
Objective Description
Maximum Length:2000
The description text of the orchestration stage objective object. -
ObjectiveName: string
Title:
Objective Name
Maximum Length:100
The name of the orchestration stage objective object. -
ObjectiveStatus: string
Title:
Objective Status
Maximum Length:30
The status of the objective. Possible values are NEW or MAPPED. -
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 name of the orchestration stage. -
OrchestrationStageNumber: string
Title:
Orchestration Stage Number
Read Only:true
Maximum Length:64
The public unique identifier of the orchestration stage object. -
StageObjectiveId: integer
(int64)
Title:
Stage Objective ID
The unique identifier of the Orchestration stage objective object. -
StageObjectiveNumber: string
Title:
Stage Objective Number
Maximum Length:64
The public unique identifier of the orchestration stage objective object.
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
- ObjectiveStatusVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_ORCH_STG_OBJ_DT_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: ObjectiveStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: