Jump to

• Request
• Response

Find an assigned journey

post

/hcmRestApi/resources/11.13.18.05/journeyAllocations/action/findByAdvancedSearchQuery

Finds an assigned journey based on the search 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

• autocompleteQuery: string
  Indicates whether the query for an assigned journey is auto completed. Valid values are Yes and No. The default value is Yes.
• displayFields: array displayFields
  Display fields for the assigned journey search response.
• filters: array filters
  Facet filters for the assigned journey search.
• limit: number
  Limit for assigned journey result fetch size.
• offset: number
  Start range for the assigned journey result limit.
• query: string
  Keyword query search for the assigned journey.
• searchFields: array searchFields
  Search fields for the assigned journey keyword query.
• sort: array sort
  Sort order of the assigned journey search results.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Start range for the assigned journey result limit.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Keyword query search for the assigned journey.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Limit for assigned journey result fetch size.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Search fields for the assigned journey keyword query.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Facet filters for the assigned journey search.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort order of the assigned journey search results.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Display fields for the assigned journey search response.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"Indicates whether the query for an assigned journey is auto completed. Valid values are Yes and No. The default value is Yes.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Display fields for the assigned journey search response.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Display fields for the assigned journey search response.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Facet filters for the assigned journey search.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Facet filters for the assigned journey search.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : searchFields

Type: array

Search fields for the assigned journey keyword query.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Search fields for the assigned journey keyword query.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Sort order of the assigned journey search results.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Sort order of the assigned journey search results.",
    "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

  Search response returned for an assigned journey query.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Search response returned for an assigned journey query."
        }
    },
    "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":"Search response returned for an assigned journey query."
}

Search response returned for an assigned journey query.

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