Jump to

• Request
• Response

Find mass assignment processes for development goals

post

/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/action/findByAdvancedSearchQuery

Finds mass assignment processes for development goals that match the specified parameters.

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 is completed automatically. Valid values are Y and N. The default value is Y.
• displayFields: array displayFields
  Attributes included in the response of the mass assignment of development goals query. The attributes can be the name of the mass assignment process or the ID of the mass assignment process.
• filters: array filters
  Filters for the mass assignment of development goals query. These filters can include attributes such as the name of the person requesting the mass assignment of development goals or the name of the mass assignment process.
• limit: number
  Count of maximum records to be retrieved.
• offset: number
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• query: string
  Query parameter defines the where clause. The resource collection is queried using the provided expressions. The value of this query parameter is one or more expressions.
• searchFields: array searchFields
  Search fields for the mass assignment of development goals query. The search field can be the name of the mass assignment process.
• sort: array sort
  Sort criteria for the mass assignment processes of development goals returned by the query. The sort criteria can include the process name or the date the mass assignment process was submitted.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Query parameter defines the where clause. The resource collection is queried using the provided expressions. The value of this query parameter is one or more expressions.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Count of maximum records to be retrieved.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Search fields for the mass assignment of development goals query. The search field can be the name of the mass assignment process.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Filters for the mass assignment of development goals query. These filters can include attributes such as the name of the person requesting the mass assignment of development goals or the name of the mass assignment process.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort criteria for the mass assignment processes of development goals returned by the query. The sort criteria can include the process name or the date the mass assignment process was submitted.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Attributes included in the response of the mass assignment of development goals query. The attributes can be the name of the mass assignment process or the ID of the mass assignment process.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"Indicates whether the query is completed automatically. Valid values are Y and N. The default value is Y.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Attributes included in the response of the mass assignment of development goals query. The attributes can be the name of the mass assignment process or the ID of the mass assignment process.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Attributes included in the response of the mass assignment of development goals query. The attributes can be the name of the mass assignment process or the ID of the mass assignment process.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Filters for the mass assignment of development goals query. These filters can include attributes such as the name of the person requesting the mass assignment of development goals or the name of the mass assignment process.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Filters for the mass assignment of development goals query. These filters can include attributes such as the name of the person requesting the mass assignment of development goals or the name of the mass assignment process.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : searchFields

Type: array

Search fields for the mass assignment of development goals query. The search field can be the name of the mass assignment process.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Search fields for the mass assignment of development goals query. The search field can be the name of the mass assignment process.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Sort criteria for the mass assignment processes of development goals returned by the query. The sort criteria can include the process name or the date the mass assignment process was submitted.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Sort criteria for the mass assignment processes of development goals returned by the query. The sort criteria can include the process name or the date the mass assignment process was submitted.",
    "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

  Response returned for the mass assignment of development goals query.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Response returned for the mass assignment of development goals 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":"Response returned for the mass assignment of development goals query."
}

Response returned for the mass assignment of development goals 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