Jump to

• Request
• Response
• Examples

Update a user task assignment

patch

/fscmRestApi/resources/11.13.18.05/collectionStrategies/{StrategyId}/child/strategyUserTasks/{UserItemId}

Request

Path Parameters

• StrategyId(required): integer(int64)
  The unique identifier of the strategy assignment.
• UserItemId(required): integer(int64)
  The unique identifier of the strategy user task.

Header Parameters

• Metadata-Context: string
  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: string
  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

• UserTaskStatus: string
  Title: User Task Status

  The status of the strategy user task. The default value of the User Task Status is NOT CREATED.
• WorkOrder: integer (int64)
  Title: Work Order

  The work order of the strategy user task. This is a mandatory attribute.

{
    "type":"object",
    "properties":{
        "WorkOrder":{
            "title":"Work Order",
            "type":"integer",
            "description":"The work order of the strategy user task. This is a mandatory attribute.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UserTaskStatus":{
            "title":"User Task Status",
            "type":"string",
            "description":"The status of the strategy user task. The default value of the User Task Status is NOT CREATED.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "UserTaskStatusMeaning"
                ]
            }
        }
    }
}

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 : collectionStrategies-strategyUserTasks-item-response

Type: object

Show Source

• 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.
• InstallmentId: number
  Title: Installment ID

  The unique identifier of the invoice installment.
• 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.
• StrategyTaskTemplate: string
  Title: Strategy Task Template

  Maximum Length: 240

  The strategy task template used for the strategy user task. This is a mandatory attribute.
• UserItemId: integer (int64)
  Title: User Item ID

  The unique identifier of the strategy user task.
• UserTaskStatus: string
  Title: User Task Status

  The status of the strategy user task. The default value of the User Task Status is NOT CREATED.
• UserTaskType: string
  Title: User Task Type

  Read Only: true

  Maximum Length: 80

  The type of the strategy user task. The value of User Task Type is set based on the strategy task template.
• WorkOrder: integer (int64)
  Title: Work Order

  The work order of the strategy user task. This is a mandatory attribute.

{
    "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 user task. This is a mandatory attribute.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InstallmentId":{
            "title":"Installment ID",
            "type":"number",
            "description":"The unique identifier of the invoice installment.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkOrder":{
            "title":"Work Order",
            "type":"integer",
            "description":"The work order of the strategy user task. This is a mandatory attribute.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserItemId":{
            "title":"User Item ID",
            "type":"integer",
            "description":"The unique identifier of the strategy user task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UserTaskType":{
            "title":"User Task Type",
            "maxLength":80,
            "type":"string",
            "description":"The type of the strategy user task. The value of User Task Type is set based on the strategy task template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UserTaskStatus":{
            "title":"User Task Status",
            "type":"string",
            "description":"The status of the strategy user task. The default value of the User Task Status is NOT CREATED.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "UserTaskStatusMeaning"
                ]
            }
        },
        "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 user 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/300100169827837/child/strategyUserTasks/300100169827839

Example Request Payload

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

{
 "WorkOrder":304
}

Example of Response Body

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

{
    "UserItemId": 300100169827839,
    "WorkOrder": 304,
    "StrategyTaskTemplate": "1Min Pre wait,0Min Post wait Automatic Task",
    "UserTaskStatus": "To Be Created",
    "UserTaskType": "Automatic",
    "CreatedBy": "COLLECTIONS_MGR_OPERATIONS",
    "CreationDate": "2018-10-18T07:18:09.285+00:00",
    "LastUpdateDate": "2018-10-18T09:24:35+00:00",
    "LastUpdatedBy": "COLLECTIONS_MGR_OPERATIONS",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/300100169827837/child/strategyUserTasks/300100169827839",
            "name": "strategyUserTasks",
            "kind": "item",
            "properties": {
                             "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                          }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/300100169827837/child/strategyUserTasks/300100169827839",
            "name": "strategyUserTasks",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/300100169827837",
            "name": "collectionStrategies",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collectionStrategies/300100169827837/child/strategyUserTasks/300100169827839/lov/userStrategyTaskTemplates",
            "name": "userStrategyTaskTemplates",
            "kind": "collection"
        }
    ]
}

Back to Top