Jump to

• Request
• Response

Get the list of interactions from OSCS by applying filter criteria

post

/hcmRestApi/resources/11.13.18.05/recruitingUIInboxMessages/action/findByAdvancedSearchQuery

Gets the list of interactions from OSCS by applying filter criteria

Request

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.

Supported Media Types

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

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

Root Schema : schema

Type: object

Show Source

• additionalParams: object additionalParams
  Additional Properties Allowed: additionalProperties

  Optional parameters to be used for getting messages from OSCS in future.
• filters: array filters
  Filter type to filter the list of interactions from OSCS.
• isParent: boolean
  Group headers such as today, yesterday, this week and so on.
• limit: number
  Maximum number of interactions to get from OSCS.
• offset: number
  Offset index to start from when getting the list of interactions from OSCS.
• query: string
  Keyword used to match when getting the list of interactions from OSCS.
• searchFields: array searchFields
  Search fields used to get the list of interactions from OSCS.
• searchId: number
  Search identifier used to get the list of interactions from OSCS.
• selectedParent: string
  Group header name selected by the user, for example, today, based on which the messages are shown.
• sort: array sort
  Sort order of the message date to get the list of interactions from OSCS.

{
    "type":"object",
    "properties":{
        "isParent":{
            "type":"boolean",
            "description":"Group headers such as today, yesterday, this week and so on.",
            "nullable":true
        },
        "offset":{
            "type":"number",
            "description":"Offset index to start from when getting the list of interactions from OSCS.",
            "nullable":true
        },
        "searchId":{
            "type":"number",
            "description":"Search identifier used to get the list of interactions from OSCS.",
            "nullable":true
        },
        "additionalParams":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Optional parameters to be used for getting messages from OSCS in future.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Keyword used to match when getting the list of interactions from OSCS.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Maximum number of interactions to get from OSCS.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Search fields used to get the list of interactions from OSCS.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Filter type to filter the list of interactions from OSCS.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort order of the message date to get the list of interactions from OSCS.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "selectedParent":{
            "type":"string",
            "description":"Group header name selected by the user, for example, today, based on which the messages are shown.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : additionalParams

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Optional parameters to be used for getting messages from OSCS in future.",
    "nullable":true
}

Optional parameters to be used for getting messages from OSCS in future.

Nested Schema : filters

Type: array

Filter type to filter the list of interactions from OSCS.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Filter type to filter the list of interactions from OSCS.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : searchFields

Type: array

Search fields used to get the list of interactions from OSCS.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Search fields used to get the list of interactions from OSCS.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Sort order of the message date to get the list of interactions from OSCS.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Sort order of the message date to get the list of interactions from OSCS.",
    "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

  Identifier to get the list of interactions with the applied parameters.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Identifier to get the list of interactions with the applied parameters."
        }
    },
    "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":"Identifier to get the list of interactions with the applied parameters."
}

Identifier to get the list of interactions with the applied parameters.

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