Jump to

• Request
• Response
• Examples

Update a task assignment

patch

/fscmRestApi/resources/11.13.18.05/collectionStrategies/{StrategyId}/child/strategyExecutionTasks/{WorkItemId}

Request

Path Parameters

• StrategyId(required): integer(int64)
  The unique identifier of the strategy assignment.
• WorkItemId(required): integer(int64)
  The unique identifier of the strategy execution task or work item.

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

• AssignedTo: string
  Title: Assigned To

  Maximum Length: 255

  The collector assigned to the strategy execution task. The value of Assigned To is populated by default as the collector assigned to the customer, account, or site, depending on the business level.
• TaskStatus: string
  Title: Task Status

  The status of the strategy execution task.

{
    "type":"object",
    "properties":{
        "AssignedTo":{
            "title":"Assigned To",
            "maxLength":255,
            "type":"string",
            "description":"The collector assigned to the strategy execution task. The value of Assigned To is populated by default as the collector assigned to the customer, account, or site, depending on the business level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TaskStatus":{
            "title":"Task Status",
            "type":"string",
            "description":"The status of the strategy execution task.",
            "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(required):
  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(required):
  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 : collectionStrategies-strategyExecutionTasks-item-response

Type: object

Show Source

• AssignedTo: string
  Title: Assigned To

  Maximum Length: 255

  The collector assigned to the strategy execution task. The value of Assigned To is populated by default as the collector assigned to the customer, account, or site, depending on the business level.
• 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.
• ExecutionEnd: string (date-time)
  Title: Execution End

  The actual end date of the strategy execution task.
• ExecutionStart: string (date-time)
  Title: Execution Start

  The actual start date of the strategy execution task.
• LastUpdateDate: string (date-time)
  Title: Last Update 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.
• PostWaitEndTime: string (date)
  Title: Postwait End Time

  The post wait end date of the strategy execution task that has post-wait time defined.
• ScheduleEnd: string (date-time)
  Title: Schedule End

  The scheduled end date of the strategy execution task.
• ScheduleStart: string (date-time)
  Title: Schedule Start

  The scheduled start date of the strategy execution task.
• StrategyTaskTemplate: string
  Title: Strategy Task Template

  Maximum Length: 240

  The strategy task template used for the strategy execution task. This is a mandatory attribute.
• TaskStatus: string
  Title: Task Status

  The status of the strategy execution task.
• TaskType: string
  Title: Task Type

  Read Only: true

  Maximum Length: 80

  The type of the strategy execution task. The value of Task Type is set based on the strategy task template.
• WorkItemId: integer (int64)
  Title: Work Item ID

  The unique identifier of the strategy execution task or work item.
• WorkOrder: integer (int64)
  Title: Work Order

  The work order of the strategy execution task.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StrategyTaskTemplate":{
            "title":"Strategy Task Template",
            "maxLength":240,
            "type":"string",
            "description":"The strategy task template used for the strategy execution task. This is a mandatory attribute.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleEnd":{
            "title":"Schedule End",
            "type":"string",
            "description":"The scheduled end date of the strategy execution task.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "TaskStatus":{
            "title":"Task Status",
            "type":"string",
            "description":"The status of the strategy execution task.",
            "nullable":true,
            "x-queryable":false
        },
        "AssignedTo":{
            "title":"Assigned To",
            "maxLength":255,
            "type":"string",
            "description":"The collector assigned to the strategy execution task. The value of Assigned To is populated by default as the collector assigned to the customer, account, or site, depending on the business level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WorkOrder":{
            "title":"Work Order",
            "type":"integer",
            "description":"The work order of the strategy execution task.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ExecutionStart":{
            "title":"Execution Start",
            "type":"string",
            "description":"The actual start date of the strategy execution task.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "TaskType":{
            "title":"Task Type",
            "maxLength":80,
            "type":"string",
            "description":"The type of the strategy execution task. The value of Task Type is set based on the strategy task template.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "WorkItemTypeCode"
                ]
            },
            "x-queryable":true
        },
        "WorkItemId":{
            "title":"Work Item ID",
            "type":"integer",
            "description":"The unique identifier of the strategy execution task or work item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PostWaitEndTime":{
            "title":"Postwait End Time",
            "type":"string",
            "description":"The post wait end date of the strategy execution task that has post-wait time defined.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ScheduleStart":{
            "title":"Schedule Start",
            "type":"string",
            "description":"The scheduled start date of the strategy execution task.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ExecutionEnd":{
            "title":"Execution End",
            "type":"string",
            "description":"The actual end date of the strategy execution task.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record 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."
        }
    }
}

Back to Top

Examples

The following example shows how to update a task assignment by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/100100055491744/child/strategyExecutionTasks/100100055487685

Example Request Payload

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

{
 "TaskStatus":"Complete"
}

Example of Response Body

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

{
    "WorkItemId": 100100055487685,
    "WorkOrder": 100,
    "StrategyTaskTemplate": "Default Work Item",
    "ScheduleStart": "2017-07-27",
    "ScheduleEnd": "2017-07-27",
    "ExecutionStart": "2017-07-27",
    "ExecutionEnd": null,
    "PostWaitEndTime": null,
    "TaskType": "Manual",
    "AssignedTo": "Hari1234",
    "CreatedBy": "COLLECTIONS_MGR_OPERATIONS",
    "CreationDate": "2017-07-27T13:32:01+00:00",
    "LastUpdateDate": "2018-10-18T06:23:40+00:00",
    "LastUpdatedBy": "COLLECTIONS_MGR_OPERATIONS",
    "TaskStatus": "Complete",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/100100055491744/child/strategyExecutionTasks/100100055487685",
            "name": "strategyExecutionTasks",
            "kind": "item",
            "properties": {
                             "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
                          }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/100100055491744/child/strategyExecutionTasks/100100055487685",
            "name": "strategyExecutionTasks",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/100100055491744",
            "name": "collectionStrategies",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/100100055491744/child/strategyExecutionTasks/100100055487685/lov/strategyTaskTemplates",
            "name": "strategyTaskTemplates",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/100100055491744/child/strategyExecutionTasks/100100055487685/lov/collectors",
            "name": "collectors",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/100100055491744/child/strategyExecutionTasks/100100055487685/lov/taskStatuses",
            "name": "taskStatuses",
            "kind": "collection"
        }
    ]
}

Back to Top