Jump to

• Request
• Response

Update a checklist task assignment

patch

/fscmRestApi/resources/11.13.18.05/hedChecklistAssignments/{hedChecklistAssignmentsUniqID}/child/checklistTaskAssignments/{TaskAssignmentId}

Request

Path Parameters

• TaskAssignmentId(required): integer(int64)
  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=
• hedChecklistAssignmentsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Checklist Assignments resource and used to uniquely identify an instance of Checklist Assignments. The client should not generate the hash key value. Instead, the client should query on the Checklist Assignments collection resource in order to navigate to a specific instance of Checklist Assignments to get the hash key.

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

• ReassignmentFlag: boolean
  Maximum Length: 1

  Default Value: false

  Allow reassignment.
• StarredFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates if the task instance is starred, which means the user has marked it as an important task to quickly locate later.
• StatusCode: string
  Title: Task Outcome Status Code

  Maximum Length: 30

  Default Value: ORA_HEY_STATUS_IN_PROGRESS

  Status code.

{
    "type":"object",
    "properties":{
        "ReassignmentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Allow reassignment.",
            "nullable":false,
            "default":false
        },
        "StarredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the task instance is starred, which means the user has marked it as an important task to quickly locate later.",
            "nullable":false,
            "default":false
        },
        "StatusCode":{
            "title":"Task Outcome Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Status code.",
            "nullable":false,
            "default":"ORA_HEY_STATUS_IN_PROGRESS",
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : hedChecklistAssignments-checklistTaskAssignments-item-response

Type: object

Show Source

• CompleteFlag: boolean
  Title: Task Complete

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether the task is completed.
• CompletionDate: string (date-time)
  Title: Task Completion Date

  Read Only: true

  Completion date.
• DueDate: string (date-time)
  Title: Task Assignment Due Date

  Due date.
• InstructionText: string
  Title: Task Instruction Text

  Read Only: true

  Instructions for the task.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NotifyAssignedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates to the user whether the assignee should receive a communication when the task is assigned.
• NotifyCompletedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates to the user whether the assignee receives a communication upon completion of the task.
• NotifyDueFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates to the user whether the assignee receives a communication when the task is due.
• ReassignmentFlag: boolean
  Maximum Length: 1

  Default Value: false

  Allow reassignment.
• StarredFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates if the task instance is starred, which means the user has marked it as an important task to quickly locate later.
• StartDate: string (date-time)
  Title: Task Start Date

  Read Only: true

  Start date.
• StatusCode: string
  Title: Task Outcome Status Code

  Maximum Length: 30

  Default Value: ORA_HEY_STATUS_IN_PROGRESS

  Status code.
• StatusMeaning: string
  Title: Task Outcome Status

  Read Only: true

  Maximum Length: 80

  Meaning of status.
• TaskAssignmentId: integer (int64)
  Title: Task Assignment Identifier

  Read Only: true

  Unique identifier for an instance of task assignment within a checklist.
• TaskCode: string
  Title: Task Code

  Read Only: true

  Maximum Length: 50

  Code for task.
• TaskDescription: string
  Title: Task Description

  Read Only: true

  Maximum Length: 240

  Description of task.
• TaskId: integer (int64)
  Title: Task Identifier

  Unique identifier for the task.
• TaskName: string
  Title: Task Name

  Read Only: true

  Maximum Length: 50

  Name of task.

{
    "type":"object",
    "properties":{
        "ReassignmentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Allow reassignment.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "NotifyCompletedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates to the user whether the assignee receives a communication upon completion of the task.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "TaskId":{
            "title":"Task Identifier",
            "type":"integer",
            "description":"Unique identifier for the task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NotifyAssignedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates to the user whether the assignee should receive a communication when the task is assigned.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "StarredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the task instance is starred, which means the user has marked it as an important task to quickly locate later.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Task Outcome Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Status code.",
            "nullable":false,
            "default":"ORA_HEY_STATUS_IN_PROGRESS",
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Task Start Date",
            "type":"string",
            "description":"Start date.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CompleteFlag":{
            "title":"Task Complete",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the task is completed.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Task Outcome Status",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskCode":{
            "title":"Task Code",
            "maxLength":50,
            "type":"string",
            "description":"Code for task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NotifyDueFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates to the user whether the assignee receives a communication when the task is due.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "TaskDescription":{
            "title":"Task Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstructionText":{
            "title":"Task Instruction Text",
            "type":"string",
            "description":"Instructions for the task.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "InstructionTextClob"
                ]
            },
            "x-queryable":true
        },
        "TaskAssignmentId":{
            "title":"Task Assignment Identifier",
            "type":"integer",
            "description":"Unique identifier for an instance of task assignment within a checklist.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "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"
            }
        },
        "DueDate":{
            "title":"Task Assignment Due Date",
            "type":"string",
            "description":"Due date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CompletionDate":{
            "title":"Task Completion Date",
            "type":"string",
            "description":"Completion date.",
            "format":"date-time",
            "nullable":true,
            "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

hedWorkflowStatusSchemesStatusesLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedWorkflowStatusSchemesStatusesLOV

Parameters:

• finder: ByStatusSchemeCodeFinder%3BStatusSchemeCode%3D{StatusSchemeCode}

The following properties are defined on the LOV link relation:

• Source Attribute: StatusCode; Target Attribute: StatusCode
• Display Attribute: StatusMeaning

Back to Top