Jump to

• Request
• Response

Delete bulk assignments of tasks

post

/fscmRestApi/resources/11.13.18.05/hedTaskAssignments/action/bulkDeleteTaskAssignments

Deletes assignments for multiple tasks in bulk. All task assignments that match the specified query parameters will be deleted in a single operation.

Request

Header Parameters

• Effective-Of: string
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• PurposeTypeCode: string
  Code for assignment purpose.
• QueryInputPayload: string
  The payload received by the query.
• RunTimeDate: string (date-time)
  The date and time for this bulk assignment to run. If this value isn't provided, the job will be scheduled immediately.
• TaskAssignment: object TaskAssignment
  Additional Properties Allowed: additionalProperties

  Removing task assignment selections. For ad-hoc selections, IDs of selected task assignments should be provided in taskAssignmentIds attribute of the request. For query select, query ID or query version ID should be provided in queryId or queryVersionId attribute of the request.

{
    "type":"object",
    "properties":{
        "QueryInputPayload":{
            "type":"string",
            "description":"The payload received by the query.",
            "nullable":true
        },
        "PurposeTypeCode":{
            "type":"string",
            "description":"Code for assignment purpose.",
            "nullable":true
        },
        "RunTimeDate":{
            "type":"string",
            "description":"The date and time for this bulk assignment to run. If this value isn't provided, the job will be scheduled immediately.",
            "format":"date-time",
            "nullable":true
        },
        "TaskAssignment":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Removing task assignment selections. For ad-hoc selections, IDs of selected task assignments should be provided in taskAssignmentIds attribute of the request. For query select, query ID or query version ID should be provided in queryId or queryVersionId attribute of the request.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : TaskAssignment

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Removing task assignment selections. For ad-hoc selections, IDs of selected task assignments should be provided in taskAssignmentIds attribute of the request. For query select, query ID or query version ID should be provided in queryId or queryVersionId attribute of the request.",
    "nullable":true
}

Removing task assignment selections. For ad-hoc selections, IDs of selected task assignments should be provided in taskAssignmentIds attribute of the request. For query select, query ID or query version ID should be provided in queryId or queryVersionId attribute of the request.

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  The unique identifier of the scheduled process that performs the bulk assignment. This value is provided in the RequestId attribute of the response.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"number"
            },
            "description":"The unique identifier of the scheduled process that performs the bulk assignment. This value is provided in the RequestId attribute of the response."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• number

{
    "type":"object",
    "additionalProperties":{
        "type":"number"
    },
    "description":"The unique identifier of the scheduled process that performs the bulk assignment. This value is provided in the RequestId attribute of the response."
}

The unique identifier of the scheduled process that performs the bulk assignment. This value is provided in the RequestId attribute of the response.

Back to Top