Jump to

• Request
• Response

Find team details

post

/hcmRestApi/resources/11.13.18.05/myTeamDetails/action/findByObject

Finds the team details of workers in a manager's team.

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

• assignmentId: number
  Assignment identifier of workers returned from a worker type object search in a manager's team details.
• autocompleteQuery: string
  Autocomplete query for the results returned from an object search in a manager's team details.
• displayFields: array displayFields
  Display fields for the results returned from an object search in a manager's team details.
• filters: array filters
  Filters for the results returned from an object search in a manager's team details.
• limit: number
  Limit for the number of results returned from an object search in a manager's team details.
• objectType: string
  Type of object to be provided for searching in a manager's team details.
• offset: number
  Offset for the results returned from an object search in a manager's team details.
• personId: number
  Person identifier of workers returned from a worker type object search in a manager's team details.
• query: string
  Query for the results returned from an object search in a manager's team details.
• searchFields: array searchFields
  Fields for searching using an object in a manager's team details.
• sort: array sort
  Sort order of the results returned from an object search in a manager's team details.
• viewType: string
  View type of the results of an object search in a manager's team details.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Offset for the results returned from an object search in a manager's team details.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Query for the results returned from an object search in a manager's team details.",
            "nullable":true
        },
        "viewType":{
            "type":"string",
            "description":"View type of the results of an object search in a manager's team details.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Limit for the number of results returned from an object search in a manager's team details.",
            "nullable":true
        },
        "personId":{
            "type":"number",
            "description":"Person identifier of workers returned from a worker type object search in a manager's team details.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Fields for searching using an object in a manager's team details.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Filters for the results returned from an object search in a manager's team details.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort order of the results returned from an object search in a manager's team details.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "assignmentId":{
            "type":"number",
            "description":"Assignment identifier of workers returned from a worker type object search in a manager's team details.",
            "nullable":true
        },
        "displayFields":{
            "type":"array",
            "description":"Display fields for the results returned from an object search in a manager's team details.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "objectType":{
            "type":"string",
            "description":"Type of object to be provided for searching in a manager's team details.",
            "nullable":true
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"Autocomplete query for the results returned from an object search in a manager's team details.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Display fields for the results returned from an object search in a manager's team details.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Display fields for the results returned from an object search in a manager's team details.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Filters for the results returned from an object search in a manager's team details.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Filters for the results returned from an object search in a manager's team details.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : searchFields

Type: array

Fields for searching using an object in a manager's team details.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Fields for searching using an object in a manager's team details.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Sort order of the results returned from an object search in a manager's team details.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Sort order of the results returned from an object search in a manager's team details.",
    "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 search using an object in a manager's team details.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Response returned for search using an object in a manager's team details."
        }
    },
    "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 search using an object in a manager's team details."
}

Response returned for search using an object in a manager's team details.

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