Jump to

• Request
• Response

Unique identifier for the payroll

patch

/hcmRestApi/resources/11.13.18.05/processResults/{FlowTaskInstanceId}/child/ArchiveResultTree/{ArchiveResultTreeUniqID}/child/ArchiveResultDetails/{ArchiveResultDetailsUniqID}

Request

Path Parameters

• ArchiveResultDetailsUniqID(required): string
  Identifier to Person Process Results
• ArchiveResultTreeUniqID(required): string
  Identifier to Person Process Results
• 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=

Header Parameters

• Effective-Of: string
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• InformationDisplayValue: string
  Unique identifier for the payroll
• InformationValue: string
  Unique identifier for the payroll
• ReportRecordId: integer (int64)
  Unique identifier for the payroll

{
    "type":"object",
    "properties":{
        "InformationDisplayValue":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true
        },
        "InformationValue":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true
        },
        "ReportRecordId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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-ArchiveResultTree-ArchiveResultDetails-item-response

Type: object

Show Source

• ActionContextId: integer (int64)
  Unique identifier for the payroll
• ActionContextType: string
  Maximum Length: 15

  Unique identifier for the payroll
• ActionInformationCategory: string
  Maximum Length: 80

  Unique identifier for the payroll
• ActionInformationId: integer (int64)
  Unique identifier for the payroll
• BaseDataElementName: string
  Read Only: true

  Maximum Length: 80

  Unique identifier for the payroll
• ContextFlag: boolean
  Title: Context Attribute

  Read Only: true

  Maximum Length: 30

  Unique identifier for the payroll
• DataElementName: string
  Title: Attribute

  Read Only: true

  Maximum Length: 80

  Unique identifier for the payroll
• DataType: string
  Title: Data Type

  Read Only: true

  Maximum Length: 80

  Unique identifier for the payroll
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 240

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

  Unique identifier for the payroll
• HideFlag: boolean
  Title: Hidden

  Read Only: true

  Maximum Length: 30

  Unique identifier for the payroll
• InformationColumn: integer
  Title: Output Column

  Read Only: true

  Unique identifier for the payroll
• InformationDisplayValue: string
  Unique identifier for the payroll
• InformationLabel: string
  Title: Output Label

  Read Only: true

  Maximum Length: 80

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

  The link relations associated with the resource instance.
• ReportRecordId: integer (int64)
  Unique identifier for the payroll
• RequiredFlag: boolean
  Title: Required

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 30

  Unique identifier for the payroll
• UiHideFlag: boolean
  Title: Results Display Option

  Read Only: true

  Maximum Length: 30

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

  Maximum Length: 30

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

  Maximum Length: 1

  Unique identifier for the payroll
• VoName: string
  Title: View Object Name

  Read Only: true

  Maximum Length: 400

  Unique identifier for the payroll

{
    "type":"object",
    "properties":{
        "ActionContextId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionContextType":{
            "maxLength":15,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":false,
            "x-queryable":true
        },
        "ActionInformationCategory":{
            "maxLength":80,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":false,
            "x-queryable":true
        },
        "ActionInformationId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "BaseDataElementName":{
            "maxLength":80,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ContextFlag":{
            "title":"Context Attribute",
            "maxLength":30,
            "type":"boolean",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DataElementName":{
            "title":"Attribute",
            "maxLength":80,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DataType":{
            "title":"Data Type",
            "maxLength":80,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExtDataElementId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "HideFlag":{
            "title":"Hidden",
            "maxLength":30,
            "type":"boolean",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InformationColumn":{
            "title":"Output Column",
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InformationDisplayValue":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "x-queryable":true
        },
        "InformationLabel":{
            "title":"Output Label",
            "maxLength":80,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InformationValue":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "x-queryable":true
        },
        "ReportRecordId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":30,
            "type":"boolean",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UiHideFlag":{
            "title":"Results Display Option",
            "maxLength":30,
            "type":"boolean",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdatableDataElement":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdatableRecord":{
            "maxLength":1,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VoName":{
            "title":"View Object Name",
            "maxLength":400,
            "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"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top