Jump to

• Request
• Response

Unique identifier for the payroll

get

/hcmRestApi/resources/11.13.18.05/processResults/{FlowTaskInstanceId}

Request

Path Parameters

• FlowTaskInstanceId(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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : processResults-item-response

Type: object

Show Source

• AttachmentEntityName: string
  Read Only: true

  Maximum Length: 14

  Unique identifier for the payroll
• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• BaseFlowId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• BaseTaskName: string
  Read Only: true

  Maximum Length: 100

  Unique identifier for the payroll
• counter: array Person Process Results
  Title: Person Process Results

  Unique identifier for the payroll
• DataSetId: integer
  Read Only: true

  Unique identifier for the payroll
• DataSetName: string
  Read Only: true

  Unique identifier for the payroll
• DateEarned: string
  Title: Date Earned

  Read Only: true

  Unique identifier for the payroll
• EssRequestId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• FlowId: integer
  Read Only: true

  Unique identifier for the payroll
• FlowInstanceId: integer
  Read Only: true

  Unique identifier for the payroll
• FlowInstanceName: string
  Title: Flow Name

  Read Only: true

  Maximum Length: 200

  Unique identifier for the payroll
• FlowName: string
  Title: Flow Pattern

  Read Only: true

  Maximum Length: 250

  Unique identifier for the payroll
• FlowTaskInstanceId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• FlowTaskName: string
  Title: Flow Task

  Read Only: true

  Maximum Length: 100

  Unique identifier for the payroll
• IsCancelling: string
  Read Only: true

  Maximum Length: 255

  Unique identifier for the payroll
• IsCompleted: string
  Read Only: true

  Maximum Length: 1

  Unique identifier for the payroll
• IsCriticalErrors: string
  Read Only: true

  Maximum Length: 1

  Unique identifier for the payroll
• IsErrors: string
  Read Only: true

  Maximum Length: 1

  Unique identifier for the payroll
• IsMarkedForRetry: string
  Read Only: true

  Maximum Length: 1

  Unique identifier for the payroll
• IsProcessing: string
  Read Only: true

  Maximum Length: 1

  Unique identifier for the payroll
• IsRolledBackRecords: string
  Read Only: true

  Maximum Length: 1

  Unique identifier for the payroll
• IsSkipped: string
  Read Only: true

  Maximum Length: 1

  Unique identifier for the payroll
• IsStopped: string
  Read Only: true

  Maximum Length: 1

  Unique identifier for the payroll
• iterations: array Person Process Results
  Title: Person Process Results

  Unique identifier for the payroll
• LegislativeDataGroupId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• LegislativeDataGroupName: string
  Title: Legislative Data Group

  Read Only: true

  Maximum Length: 240

  Unique identifier for the payroll
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoggingTurnedOn: string
  Title: Logging Level

  Read Only: true

  Unique identifier for the payroll
• Messages: integer
  Title: Message Count

  Read Only: true

  Unique identifier for the payroll
• parameters: array Person Process Results
  Title: Person Process Results

  Unique identifier for the payroll
• PayrollActionId: integer
  Read Only: true

  Unique identifier for the payroll
• PayrollId: integer
  Read Only: true

  Unique identifier for the payroll
• PayrollName: string
  Title: Payroll Name

  Read Only: true

  Maximum Length: 80

  Unique identifier for the payroll
• PeriodName: string
  Title: Period Name

  Read Only: true

  Unique identifier for the payroll
• ProcessDate: string (date)
  Title: Process Date

  Read Only: true

  Unique identifier for the payroll
• Processed: number
  Read Only: true

  Unique identifier for the payroll
• processGroupType: array Person Process Results
  Title: Person Process Results
• processHistory: array Person Process Results
  Title: Person Process Results

  Unique identifier for the payroll
• ProcessLogs: array Person Process Results
  Title: Person Process Results

  Unique identifier for the payroll
• processMessage: array Person Process Results
  Title: Person Process Results

  Unique identifier for the payroll
• processObjectAction: array Person Process Results
  Title: Person Process Results

  Unique identifier for the payroll
• QuickpayTaskFlag: boolean
  Read Only: true

  Maximum Length: 1

  Unique identifier for the payroll
• Record: integer
  Title: Records

  Read Only: true

  Unique identifier for the payroll
• RollbackErrorFlag: boolean
  Read Only: true

  Maximum Length: 1

  Unique identifier for the payroll
• StatErrorTotal: integer
  Read Only: true

  Unique identifier for the payroll
• StatutoryPeriod: string
  Title: Period Number

  Read Only: true

  Unique identifier for the payroll
• SubmissionDate: string (date)
  Title: Submitted On

  Read Only: true

  Unique identifier for the payroll
• SubmitAnotherTask: string
  Read Only: true

  Maximum Length: 19

  Unique identifier for the payroll
• SubmittedBy: string
  Title: Submitted By

  Read Only: true

  Maximum Length: 64

  Unique identifier for the payroll
• TaskId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• TaskName: string
  Read Only: true

  Maximum Length: 250

  Unique identifier for the payroll
• TaskStatus: string
  Read Only: true

  Maximum Length: 20

  Unique identifier for the payroll
• TaskStatusMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  Unique identifier for the payroll
• TaskSubStatus: string
  Title: Status

  Read Only: true

  Maximum Length: 20

  Unique identifier for the payroll
• TaskSubStatusMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  Unique identifier for the payroll
• TaskType: string
  Read Only: true

  Maximum Length: 30

  Unique identifier for the payroll
• TaskTypeCode: string
  Read Only: true

  Maximum Length: 30

  Unique identifier for the payroll
• TaskTypeMeaning: string
  Title: Task Type

  Read Only: true

  Maximum Length: 80

  Unique identifier for the payroll
• TimeElapsed: string
  Title: Time Taken in Minutes

  Read Only: true

  Unique identifier for the payroll
• TiRequestId: integer
  Read Only: true

  Unique identifier for the payroll
• Type: string
  Title: Task Type

  Unique identifier for the payroll
• Unprocessed: number
  Read Only: true

  Unique identifier for the payroll

{
    "type":"object",
    "properties":{
        "TaskTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuickpayTaskFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatutoryPeriod":{
            "title":"Period Number",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlowTaskName":{
            "title":"Flow Task",
            "maxLength":"100",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RollbackErrorFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskSubStatus":{
            "title":"Status",
            "maxLength":"20",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "processObjectAction":{
            "title":"Person Process Results",
            "type":"array",
            "description":"Unique identifier for the payroll",
            "items":{
                "$ref":"#/components/schemas/processResults-processObjectAction-item-response"
            }
        },
        "Unprocessed":{
            "type":"number",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsErrors":{
            "maxLength":"1",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsCancelling":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmissionDate":{
            "title":"Submitted On",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TiRequestId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DataSetName":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlowId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PayrollName":{
            "title":"Payroll Name",
            "maxLength":"80",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "processGroupType":{
            "title":"Person Process Results",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/processResults-processGroupType-item-response"
            }
        },
        "processHistory":{
            "title":"Person Process Results",
            "type":"array",
            "description":"Unique identifier for the payroll",
            "items":{
                "$ref":"#/components/schemas/processResults-processHistory-item-response"
            }
        },
        "BaseTaskName":{
            "maxLength":"100",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskType":{
            "maxLength":"30",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsMarkedForRetry":{
            "maxLength":"1",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IsCriticalErrors":{
            "maxLength":"1",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsProcessing":{
            "maxLength":"1",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Processed":{
            "type":"number",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Messages":{
            "title":"Message Count",
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsCompleted":{
            "maxLength":"1",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsRolledBackRecords":{
            "maxLength":"1",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlowInstanceId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmittedBy":{
            "title":"Submitted By",
            "maxLength":"64",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskTypeMeaning":{
            "title":"Task Type",
            "maxLength":"80",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "iterations":{
            "title":"Person Process Results",
            "type":"array",
            "description":"Unique identifier for the payroll",
            "items":{
                "$ref":"#/components/schemas/processResults-iterations-item-response"
            }
        },
        "IsStopped":{
            "maxLength":"1",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskName":{
            "maxLength":"250",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FlowName":{
            "title":"Flow Pattern",
            "maxLength":"250",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskSubStatusMeaning":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodName":{
            "title":"Period Name",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "parameters":{
            "title":"Person Process Results",
            "type":"array",
            "description":"Unique identifier for the payroll",
            "items":{
                "$ref":"#/components/schemas/processResults-parameters-item-response"
            }
        },
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StatErrorTotal":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/processResults-attachments-item-response"
            }
        },
        "processMessage":{
            "title":"Person Process Results",
            "type":"array",
            "description":"Unique identifier for the payroll",
            "items":{
                "$ref":"#/components/schemas/processResults-processMessage-item-response"
            }
        },
        "TaskStatusMeaning":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TimeElapsed":{
            "title":"Time Taken in Minutes",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BaseFlowId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EssRequestId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FlowTaskInstanceId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LegislativeDataGroupName":{
            "title":"Legislative Data Group",
            "maxLength":"240",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Record":{
            "title":"Records",
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitAnotherTask":{
            "maxLength":"19",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayrollActionId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayrollId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsSkipped":{
            "maxLength":"1",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessLogs":{
            "title":"Person Process Results",
            "type":"array",
            "description":"Unique identifier for the payroll",
            "items":{
                "$ref":"#/components/schemas/processResults-ProcessLogs-item-response"
            }
        },
        "ProcessDate":{
            "title":"Process Date",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DataSetId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "counter":{
            "title":"Person Process Results",
            "type":"array",
            "description":"Unique identifier for the payroll",
            "items":{
                "$ref":"#/components/schemas/processResults-counter-item-response"
            }
        },
        "TaskStatus":{
            "maxLength":"20",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Type":{
            "title":"Task Type",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "facetControl":"checkBox"
            },
            "x-queryable":true
        },
        "FlowInstanceName":{
            "title":"Flow Name",
            "maxLength":"200",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DateEarned":{
            "title":"Date Earned",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentEntityName":{
            "maxLength":"14",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LoggingTurnedOn":{
            "title":"Logging Level",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object processResults-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/processResults-attachments-item-response"
    }
}

Nested Schema : Person Process Results

Type: array

Title: Person Process Results

Unique identifier for the payroll

Show Source

• Array of: object processResults-counter-item-response

{
    "title":"Person Process Results",
    "type":"array",
    "description":"Unique identifier for the payroll",
    "items":{
        "$ref":"#/components/schemas/processResults-counter-item-response"
    }
}

Nested Schema : Person Process Results

Type: array

Title: Person Process Results

Unique identifier for the payroll

Show Source

• Array of: object processResults-iterations-item-response

{
    "title":"Person Process Results",
    "type":"array",
    "description":"Unique identifier for the payroll",
    "items":{
        "$ref":"#/components/schemas/processResults-iterations-item-response"
    }
}

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 : Person Process Results

Type: array

Title: Person Process Results

Unique identifier for the payroll

Show Source

• Array of: object processResults-parameters-item-response

{
    "title":"Person Process Results",
    "type":"array",
    "description":"Unique identifier for the payroll",
    "items":{
        "$ref":"#/components/schemas/processResults-parameters-item-response"
    }
}

Nested Schema : Person Process Results

Type: array

Title: Person Process Results

Show Source

• Array of: object processResults-processGroupType-item-response

{
    "title":"Person Process Results",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/processResults-processGroupType-item-response"
    }
}

Nested Schema : Person Process Results

Type: array

Title: Person Process Results

Unique identifier for the payroll

Show Source

• Array of: object processResults-processHistory-item-response

{
    "title":"Person Process Results",
    "type":"array",
    "description":"Unique identifier for the payroll",
    "items":{
        "$ref":"#/components/schemas/processResults-processHistory-item-response"
    }
}

Nested Schema : Person Process Results

Type: array

Title: Person Process Results

Unique identifier for the payroll

Show Source

• Array of: object processResults-ProcessLogs-item-response

{
    "title":"Person Process Results",
    "type":"array",
    "description":"Unique identifier for the payroll",
    "items":{
        "$ref":"#/components/schemas/processResults-ProcessLogs-item-response"
    }
}

Nested Schema : Person Process Results

Type: array

Title: Person Process Results

Unique identifier for the payroll

Show Source

• Array of: object processResults-processMessage-item-response

{
    "title":"Person Process Results",
    "type":"array",
    "description":"Unique identifier for the payroll",
    "items":{
        "$ref":"#/components/schemas/processResults-processMessage-item-response"
    }
}

Nested Schema : Person Process Results

Type: array

Title: Person Process Results

Unique identifier for the payroll

Show Source

• Array of: object processResults-processObjectAction-item-response

{
    "title":"Person Process Results",
    "type":"array",
    "description":"Unique identifier for the payroll",
    "items":{
        "$ref":"#/components/schemas/processResults-processObjectAction-item-response"
    }
}

Nested Schema : processResults-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• 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: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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."
        }
    }
}

Nested Schema : processResults-counter-item-response

Type: object

Show Source

• Failed: integer
  Read Only: true

  Unique identifier for the payroll
• FlowTaskInstanceId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• Ignored: integer
  Read Only: true

  Unique identifier for the payroll
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MarkForRetry: number
  Read Only: true

  Unique identifier for the payroll
• PayRequestId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• PayrollActionId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• Pending: integer
  Read Only: true

  Unique identifier for the payroll
• Status: string
  Read Only: true

  Maximum Length: 5

  Unique identifier for the payroll
• Success: integer
  Read Only: true

  Unique identifier for the payroll
• Total: integer
  Read Only: true

  Unique identifier for the payroll

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":"5",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayRequestId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FlowTaskInstanceId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Failed":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Total":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MarkForRetry":{
            "type":"number",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayrollActionId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Success":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Ignored":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Pending":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "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 : processResults-iterations-item-response

Type: object

Show Source

• ActionType: string
  Read Only: true

  Maximum Length: 30

  Unique identifier for the payroll
• AttachmentEntityName: string
  Read Only: true

  Maximum Length: 14

  Unique identifier for the payroll
• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• EssCallId: integer
  Read Only: true

  Unique identifier for the payroll
• EssRequestId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• FlowTaskInstanceId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• IterationName: string
  Read Only: true

  Maximum Length: 291

  Unique identifier for the payroll
• IterationStatus: string
  Read Only: true

  Maximum Length: 80

  Unique identifier for the payroll
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PayrollActionId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• RequestId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• TaskType: string
  Read Only: true

  Maximum Length: 80

  Unique identifier for the payroll
• TaskTypeCode: string
  Read Only: true

  Maximum Length: 30

  Unique identifier for the payroll

{
    "type":"object",
    "properties":{
        "TaskTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionType":{
            "maxLength":"30",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/processResults-iterations-attachments-item-response"
            }
        },
        "IterationName":{
            "maxLength":"291",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IterationStatus":{
            "maxLength":"80",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EssRequestId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FlowTaskInstanceId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaskType":{
            "maxLength":"80",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EssCallId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayrollActionId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttachmentEntityName":{
            "maxLength":"14",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object processResults-iterations-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/processResults-iterations-attachments-item-response"
    }
}

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 : processResults-iterations-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• 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: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : processResults-parameters-item-response

Type: object

Show Source

• FlowTaskInstanceId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParamDispType: string
  Read Only: true

  Maximum Length: 30

  Unique identifier for the payroll
• ParameterName: string
  Read Only: true

  Maximum Length: 250

  Unique identifier for the payroll
• ParameterValue: string
  Read Only: true

  Maximum Length: 300

  Unique identifier for the payroll

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParameterName":{
            "maxLength":"250",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlowTaskInstanceId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParameterValue":{
            "maxLength":"300",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParamDispType":{
            "maxLength":"30",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "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 : processResults-processGroupType-item-response

Type: object

Show Source

• FlowTaskInstanceId: integer
  Read Only: true
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectActionType: string
  Read Only: true

  Maximum Length: 7
• PayRequestId: integer (int64)
  Read Only: true
• PayrollActionId: integer (int64)
  Read Only: true

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PayRequestId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FlowTaskInstanceId":{
            "type":"integer",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayrollActionId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectActionType":{
            "maxLength":"7",
            "type":"string",
            "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 : processResults-processHistory-item-response

Type: object

Show Source

• ActionLevel: string
  Read Only: true

  Maximum Length: 255

  Unique identifier for the payroll
• ActionName: string
  Read Only: true

  Maximum Length: 800

  Unique identifier for the payroll
• EssId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• FlowInstanceId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• FlowTaskInstanceId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• ImpactedPopulation: integer
  Read Only: true

  Unique identifier for the payroll
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParentEssId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• PersonIdentfier: string
  Read Only: true

  Maximum Length: 4000

  Unique identifier for the payroll
• SubmittedOn: string (date-time)
  Read Only: true

  Unique identifier for the payroll
• UserName: string
  Read Only: true

  Maximum Length: 64

  Unique identifier for the payroll

{
    "type":"object",
    "properties":{
        "ActionName":{
            "maxLength":"800",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmittedOn":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EssId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActionLevel":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UserName":{
            "maxLength":"64",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlowTaskInstanceId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ImpactedPopulation":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlowInstanceId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParentEssId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersonIdentfier":{
            "maxLength":"4000",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "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 : processResults-ProcessLogs-item-response

Type: object

Show Source

• Absparentid: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• Completedtime: string (date-time)
  Read Only: true

  Unique identifier for the payroll
• Definition: string
  Read Only: true

  Maximum Length: 800

  Unique identifier for the payroll
• Deleted: string
  Read Only: true

  Maximum Length: 1

  Unique identifier for the payroll
• ElapsedTime: string
  Read Only: true

  Maximum Length: 27

  Unique identifier for the payroll
• EntityName: string
  Read Only: true

  Maximum Length: 19

  Unique identifier for the payroll
• Errortype: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• ExecutableStatus: string
  Read Only: true

  Maximum Length: 100

  Unique identifier for the payroll
• Executionattempt: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• FinishTime: string (date-time)
  Read Only: true

  Unique identifier for the payroll
• FlowTaskInstanceId: integer
  Read Only: true

  Unique identifier for the payroll
• Instanceparentid: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Parentrequestid: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• Priority: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• Processend: string (date-time)
  Read Only: true

  Unique identifier for the payroll
• ProcessId: integer
  Read Only: true

  Unique identifier for the payroll
• ProcessName: string
  Read Only: true

  Maximum Length: 800

  Unique identifier for the payroll
• Processstart: string (date-time)
  Read Only: true

  Unique identifier for the payroll
• Readywaittime: string
  Read Only: true

  Maximum Length: 27

  Unique identifier for the payroll
• ReqName: string
  Read Only: true

  Maximum Length: 4000

  Unique identifier for the payroll
• Requestedend: string (date-time)
  Read Only: true

  Unique identifier for the payroll
• Requestedstart: string (date-time)
  Read Only: true

  Unique identifier for the payroll
• Scheduled: string (date-time)
  Read Only: true

  Unique identifier for the payroll
• ScheduledTime: string (date-time)
  Read Only: true

  Unique identifier for the payroll
• StartTime: string (date-time)
  Read Only: true

  Unique identifier for the payroll
• State: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• Status: string
  Read Only: true

  Maximum Length: 80

  Unique identifier for the payroll
• Submission: string (date-time)
  Read Only: true

  Unique identifier for the payroll
• Submitter: string
  Read Only: true

  Maximum Length: 1000

  Unique identifier for the payroll
• Submitterguid: string
  Read Only: true

  Maximum Length: 1000

  Unique identifier for the payroll
• Type: string
  Read Only: true

  Maximum Length: 250

  Unique identifier for the payroll
• Username: string
  Read Only: true

  Maximum Length: 1000

  Unique identifier for the payroll
• WaitTime: string
  Read Only: true

  Maximum Length: 27

  Unique identifier for the payroll

{
    "type":"object",
    "properties":{
        "ProcessName":{
            "maxLength":"800",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/processResults-ProcessLogs-attachments-item-response"
            }
        },
        "EntityName":{
            "maxLength":"19",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Processstart":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Errortype":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"38"
            },
            "x-queryable":true
        },
        "Submitterguid":{
            "maxLength":"1000",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ElapsedTime":{
            "maxLength":"27",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExecutableStatus":{
            "maxLength":"100",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Requestedend":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Scheduled":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Parentrequestid":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Submitter":{
            "maxLength":"1000",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlowTaskInstanceId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FinishTime":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Completedtime":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Processend":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Deleted":{
            "maxLength":"1",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReqName":{
            "maxLength":"4000",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Instanceparentid":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Status":{
            "maxLength":"80",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Executionattempt":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"38"
            },
            "x-queryable":true
        },
        "ScheduledTime":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Requestedstart":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Submission":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Priority":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"38"
            },
            "x-queryable":true
        },
        "StartTime":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Definition":{
            "maxLength":"800",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Readywaittime":{
            "maxLength":"27",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Absparentid":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Type":{
            "maxLength":"250",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Username":{
            "maxLength":"1000",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"38"
            },
            "x-queryable":true
        },
        "ProcessId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WaitTime":{
            "maxLength":"27",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object processResults-ProcessLogs-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/processResults-ProcessLogs-attachments-item-response"
    }
}

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 : processResults-ProcessLogs-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• 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: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : processResults-processMessage-item-response

Type: object

Show Source

• FlowId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• LineText: string
  Title: Message Text

  Read Only: true

  Maximum Length: 4000

  Unique identifier for the payroll
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageLevel: string
  Title: Severity Level

  Read Only: true

  Maximum Length: 1

  Unique identifier for the payroll
• MessageName: string
  Read Only: true

  Maximum Length: 255

  Unique identifier for the payroll
• NumberOfMessages: integer
  Title: Volume

  Read Only: true

  Unique identifier for the payroll
• TaskInstanceId: integer (int64)
  Read Only: true

  Unique identifier for the payroll

{
    "type":"object",
    "properties":{
        "FlowId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaskInstanceId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LineText":{
            "title":"Message Text",
            "maxLength":"4000",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberOfMessages":{
            "title":"Volume",
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MessageLevel":{
            "title":"Severity Level",
            "maxLength":"1",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageName":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "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 : processResults-processObjectAction-item-response

Type: object

Show Source

• ActionStatusCode: string
  Read Only: true

  Maximum Length: 30

  Unique identifier for the payroll
• ActionType: string
  Read Only: true

  Maximum Length: 80

  Unique identifier for the payroll
• ActionTypeCode: string
  Read Only: true

  Maximum Length: 30

  Unique identifier for the payroll
• ArchiveContextType: string
  Read Only: true

  Maximum Length: 4

  Unique identifier for the payroll
• ArchResultsDisplayFlag: boolean
  Read Only: true

  Maximum Length: 1

  Unique identifier for the payroll
• ChildObjectActionId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• Column1: string
  Read Only: true

  Maximum Length: 4000

  Unique identifier for the payroll
• Column10: string
  Read Only: true

  Maximum Length: 4000

  Unique identifier for the payroll
• Column2: string
  Read Only: true

  Maximum Length: 4000

  Unique identifier for the payroll
• Column3: string
  Read Only: true

  Maximum Length: 4000

  Unique identifier for the payroll
• Column4: string
  Read Only: true

  Maximum Length: 4000

  Unique identifier for the payroll
• Column5: string
  Read Only: true

  Maximum Length: 4000

  Unique identifier for the payroll
• Column6: string
  Read Only: true

  Maximum Length: 4000

  Unique identifier for the payroll
• Column7: string
  Read Only: true

  Maximum Length: 4000

  Unique identifier for the payroll
• Column8: string
  Read Only: true

  Maximum Length: 4000

  Unique identifier for the payroll
• Column9: string
  Read Only: true

  Maximum Length: 4000

  Unique identifier for the payroll
• FlowInstanceId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• FlowName: string
  Read Only: true

  Maximum Length: 200

  Unique identifier for the payroll
• LegislativeDataGroupId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• LegislativeDataGroupName: string
  Read Only: true

  Maximum Length: 240

  Unique identifier for the payroll
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MarkforretryAllowedFlag: boolean
  Read Only: true

  Maximum Length: 1

  Unique identifier for the payroll
• MessagesDisplayFlag: boolean
  Read Only: true

  Maximum Length: 1

  Unique identifier for the payroll
• ObjectActionId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• ObjectId: integer
  Read Only: true

  Unique identifier for the payroll
• ObjectName: string
  Read Only: true

  Maximum Length: 4000

  Unique identifier for the payroll
• ObjectType: string
  Read Only: true

  Maximum Length: 30

  Unique identifier for the payroll
• PayRequestId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• PayrollActionId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• PrimaryResults: string
  Read Only: true

  Maximum Length: 15

  Unique identifier for the payroll
• ProcessDate: string (date)
  Read Only: true

  Unique identifier for the payroll
• RollbackAllowedFlag: boolean
  Read Only: true

  Maximum Length: 1

  Unique identifier for the payroll
• Status: string
  Read Only: true

  Maximum Length: 80

  Unique identifier for the payroll
• SubmissionDate: string (date)
  Read Only: true

  Unique identifier for the payroll
• TaskInstanceId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• TaskName: string
  Read Only: true

  Maximum Length: 250

  Unique identifier for the payroll

{
    "type":"object",
    "properties":{
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActionType":{
            "maxLength":"80",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmissionDate":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectType":{
            "maxLength":"30",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessagesDisplayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayRequestId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Column6":{
            "maxLength":"4000",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Column7":{
            "maxLength":"4000",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LegislativeDataGroupName":{
            "maxLength":"240",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Column8":{
            "maxLength":"4000",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Column9":{
            "maxLength":"4000",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChildObjectActionId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RollbackAllowedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayrollActionId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectActionId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Status":{
            "maxLength":"80",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Column10":{
            "maxLength":"4000",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Column2":{
            "maxLength":"4000",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Column3":{
            "maxLength":"4000",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessDate":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlowInstanceId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Column4":{
            "maxLength":"4000",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Column5":{
            "maxLength":"4000",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MarkforretryAllowedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Column1":{
            "maxLength":"4000",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectName":{
            "maxLength":"4000",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskInstanceId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PrimaryResults":{
            "maxLength":"15",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ArchiveContextType":{
            "maxLength":"4",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskName":{
            "maxLength":"250",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ArchResultsDisplayFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlowName":{
            "maxLength":"200",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "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"
    }
}

Links

ProcessLogs

Operation: /hcmRestApi/resources/11.13.18.05/processResults/{FlowTaskInstanceId}/child/ProcessLogs

Parameters:

• FlowTaskInstanceId: $request.path.FlowTaskInstanceId

Unique identifier for the payroll

attachments

Operation: /hcmRestApi/resources/11.13.18.05/processResults/{FlowTaskInstanceId}/child/attachments

Parameters:

• FlowTaskInstanceId: $request.path.FlowTaskInstanceId

canUserTakeAction

Operation: /hcmRestApi/resources/11.13.18.05/processResults/{FlowTaskInstanceId}/action/canUserTakeAction

Parameters:

• FlowTaskInstanceId: $request.path.FlowTaskInstanceId

Unique identifier for the payroll

counter

Operation: /hcmRestApi/resources/11.13.18.05/processResults/{FlowTaskInstanceId}/child/counter

Parameters:

• FlowTaskInstanceId: $request.path.FlowTaskInstanceId

Unique identifier for the payroll

iterations

Operation: /hcmRestApi/resources/11.13.18.05/processResults/{FlowTaskInstanceId}/child/iterations

Parameters:

• FlowTaskInstanceId: $request.path.FlowTaskInstanceId

Unique identifier for the payroll

parameters

Operation: /hcmRestApi/resources/11.13.18.05/processResults/{FlowTaskInstanceId}/child/parameters

Parameters:

• FlowTaskInstanceId: $request.path.FlowTaskInstanceId

Unique identifier for the payroll

performAction

Operation: /hcmRestApi/resources/11.13.18.05/processResults/{FlowTaskInstanceId}/action/performAction

Parameters:

• FlowTaskInstanceId: $request.path.FlowTaskInstanceId

Unique identifier for the payroll

processGroupType

Operation: /hcmRestApi/resources/11.13.18.05/processResults/{FlowTaskInstanceId}/child/processGroupType

Parameters:

• FlowTaskInstanceId: $request.path.FlowTaskInstanceId

Unique identifier for the payroll

processHistory

Operation: /hcmRestApi/resources/11.13.18.05/processResults/{FlowTaskInstanceId}/child/processHistory

Parameters:

• FlowTaskInstanceId: $request.path.FlowTaskInstanceId

Unique identifier for the payroll

processMessage

Operation: /hcmRestApi/resources/11.13.18.05/processResults/{FlowTaskInstanceId}/child/processMessage

Parameters:

• FlowTaskInstanceId: $request.path.FlowTaskInstanceId

Unique identifier for the payroll

processObjectAction

Operation: /hcmRestApi/resources/11.13.18.05/processResults/{FlowTaskInstanceId}/child/processObjectAction

Parameters:

• FlowTaskInstanceId: $request.path.FlowTaskInstanceId

Unique identifier for the payroll

Back to Top