Jump to

• Request
• Response

Create bulk assignments of tasks

post

/fscmRestApi/resources/11.13.18.05/hedTaskAssignments/action/bulkAssignTasks

Creates bulk assignments of tasks. After all assignees are selected, the selected tasks will be assigned to all selected persons simultaneously in a single action.

Request

Header Parameters

• Effective-Of:
  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:
  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/vnd.oracle.adf.action+json

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

Root Schema : schema

Type: object

Show Source

• InstitutionId: number
  Unique identifier for institution.
• PurposeTypeCode: string
  Code for assignment purpose.
• QueryCriteria: array QueryCriteria
  The query criteria to search for assignees and optional associated objects depending on the PurposeTypeCode. It accepts an array of objects with the following attributes: AttributeName, Operator, AttributeValueOne, and AttributeValueTwo.
• QueryKeyword: string
  The keyword to search for assignees and optional associated objects.
• 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.
• Tasks: array Tasks
  List of task identifiers and their notification preferences and due date.

{
    "type":"object",
    "properties":{
        "Tasks":{
            "type":"array",
            "description":"List of task identifiers and their notification preferences and due date.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "InstitutionId":{
            "type":"number",
            "description":"Unique identifier for institution.",
            "nullable":true
        },
        "QueryCriteria":{
            "type":"array",
            "description":"The query criteria to search for assignees and optional associated objects depending on the PurposeTypeCode. It accepts an array of objects with the following attributes: AttributeName, Operator, AttributeValueOne, and AttributeValueTwo.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "QueryKeyword":{
            "type":"string",
            "description":"The keyword to search for assignees and optional associated objects.",
            "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
        }
    },
    "additionalProperties":false
}

Nested Schema : QueryCriteria

Type: array

The query criteria to search for assignees and optional associated objects depending on the PurposeTypeCode. It accepts an array of objects with the following attributes: AttributeName, Operator, AttributeValueOne, and AttributeValueTwo.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"The query criteria to search for assignees and optional associated objects depending on the PurposeTypeCode. It accepts an array of objects with the following attributes: AttributeName, Operator, AttributeValueOne, and AttributeValueTwo.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : Tasks

Type: array

List of task identifiers and their notification preferences and due date.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"List of task identifiers and their notification preferences and due date.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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