Jump to

• Request
• Response

Find areas of responsibility information

post

/hcmRestApi/resources/11.13.18.05/areasOfResponsibility/action/findByAdvancedSearch

Finds areas of responsibility records that match the specified advance search criteria. This returns the filtered records.

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

• autocompleteQuery: string
  Autocomplete query for the specified advance search criteria.
• displayFields: array displayFields
  Display fields for the specified advance search criteria.
• filters: array filters
  Filters for the specified advance search criteria.
• limit: number
  Limit for the advance search results.
• offset: number
  Offset for the specified advance search criteria.
• query: string
  Query for the specified advance search criteria.
• searchFields: array searchFields
  Search fields for the specified advance search criteria.
• sort: array sort
  Sort order for the specified advance search criteria.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Offset for the specified advance search criteria.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Query for the specified advance search criteria.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Limit for the advance search results.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Search fields for the specified advance search criteria.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Filters for the specified advance search criteria.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort order for the specified advance search criteria.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Display fields for the specified advance search criteria.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"Autocomplete query for the specified advance search criteria.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Display fields for the specified advance search criteria.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Display fields for the specified advance search criteria.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Filters for the specified advance search criteria.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Filters for the specified advance search criteria.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : searchFields

Type: array

Search fields for the specified advance search criteria.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Search fields for the specified advance search criteria.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Sort order for the specified advance search criteria.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Sort order for the specified advance search criteria.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

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

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

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

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

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

  Results for the specified advance search criteria.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Results for the specified advance search criteria."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "description":"Results for the specified advance search criteria."
}

Results for the specified advance search criteria.

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

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

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

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

Back to Top