Jump to

• Request
• Response

Scope details for the responsibility template.

post

/hcmRestApi/resources/11.13.18.05/areasOfResponsibility/action/getAorScopeDetails

Gets the responsibility template's scope details when creating a responsibility from a template.

Request

Header Parameters

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

Supported Media Types

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

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

Root Schema : schema

Type: object

Show Source

• name: array name
  Responsibility template's scope attribute name.
• value: array value
  Responsibility template's scope attribute value or description.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"array",
            "description":"Responsibility template's scope attribute name.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "value":{
            "type":"array",
            "description":"Responsibility template's scope attribute value or description.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : name

Type: array

Responsibility template's scope attribute name.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Responsibility template's scope attribute name.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : value

Type: array

Responsibility template's scope attribute value or description.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Responsibility template's scope attribute value or description.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

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

  Results for the specified template scope attribute details.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Results for the specified template scope attribute details."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Results for the specified template scope attribute details."
}

Results for the specified template scope attribute details.

Back to Top