Jump to

• Request
• Response

Return list

post

/api/v1/data/applications

This API returns the application list as per the ListMetaInfo provided. The applications are filtered and sorted as per the information in ListMetaInfo. Currently, simple filters are supported (filters available in the metadata). Complex filters require the list of values APIs to select the filter input.

Request

Supported Media Types

• application/json

Body ()

The ListMetaInfo used to retrieve the data. ListMetaInfo can contain sorting information, filtering information, pagination details along with the context ID and list format ID.

Root Schema : ListMetaInfo

Type: object

Show Source

• columnsToSort: array columnsToSort
  The columns on which the sort is applied.
• contextId: integer
  The context identifier for the current list format.
• filterList: array filterList
  The list of filters that must be applied on the list.
• formatId: integer
  The list format used for the current list format.
• limit: integer
  The page size for the list.
• offset: integer
  The page index from which the data must be returned.

{
    "type":"object",
    "properties":{
        "contextId":{
            "description":" The context identifier for the current list format.",
            "type":"integer"
        },
        "formatId":{
            "description":"The list format used for the current list format.",
            "type":"integer"
        },
        "offset":{
            "description":"The page index from which the data must be returned.",
            "type":"integer"
        },
        "limit":{
            "description":"The page size for the list.",
            "type":"integer"
        },
        "columnsToSort":{
            "description":"The columns on which the sort is applied.",
            "items":{
                "$ref":"#/definitions/SortInfo"
            }
        },
        "filterList":{
            "description":"The list of filters that must be applied on the list.",
            "items":{
                "$ref":"#/definitions/FilterInformation"
            },
            "type":"array"
        }
    }
}

Nested Schema : columnsToSort

Type: array

The columns on which the sort is applied.

Show Source

• [0]: object SortInfo

{
    "description":"The columns on which the sort is applied.",
    "items":{
        "$ref":"#/definitions/SortInfo"
    }
}

Nested Schema : filterList

Type: array

The list of filters that must be applied on the list.

Show Source

• [0]: object FilterInformation

{
    "description":"The list of filters that must be applied on the list.",
    "items":{
        "$ref":"#/definitions/FilterInformation"
    },
    "type":"array"
}

Nested Schema : SortInfo

Type: object

Show Source

• columnId: integer
  The column on which the sort is done.
• sortingSequence: integer
  The sorting sequence for the column.
• sortType: string
  The sorting type for the column. It can have ASC for ascending and DSC for descending.

{
    "type":"object",
    "properties":{
        "columnId":{
            "description":"The column on which the sort is done.",
            "type":"integer"
        },
        "sortingSequence":{
            "description":"The sorting sequence for the column.",
            "type":"integer"
        },
        "sortType":{
            "description":"The sorting type for the column. It can have ASC for ascending and DSC for descending.",
            "type":"string"
        }
    }
}

Nested Schema : FilterInformation

Type: object

Show Source

• advancedFilter: boolean
  The field indicates if the filter is an advanced filter.
• defaultEntityValueKey: integer
  The default entity value key.
• defaultValues: array defaultValues
• fieldAlias: string
  The alias name of the field on which the filter applies.
• fieldNo: integer
  The field number on which the filter applies.
• fieldPath: string
  The field path on which the filter applies.
• fieldType: string
  The type of field on which the filter applies.
• filterName: string
  The name of the filter.
• filterNo: integer
  The filter number which uniquely identifies the filter.
• filterOperators: array filterOperators
• filterPath: string
  The filter path.
• filterType: integer
  The filter type.
• measurementUnit: string
  The measurement unit for the filter.
• possibleValues: array possibleValues
• sectionName: string
  The section name.
• sectionNo: integer
  The section number.
• selectedByDefault: boolean
  An explanation about the purpose of the instance.
• values: array values

{
    "properties":{
        "advancedFilter":{
            "description":" The field indicates if the filter is an advanced filter.",
            "type":"boolean"
        },
        "defaultEntityValueKey":{
            "description":"The default entity value key.",
            "type":"integer"
        },
        "defaultValues":{
            "items":{
                "description":"The default values to be applied for the filter.",
                "type":"integer"
            },
            "type":"array"
        },
        "fieldAlias":{
            "description":"The alias name of the field on which the filter applies.",
            "type":"string"
        },
        "fieldNo":{
            "description":"The field number on which the filter applies.",
            "type":"integer"
        },
        "fieldPath":{
            "description":"The field path on which the filter applies.",
            "type":"string"
        },
        "fieldType":{
            "description":"The type of field on which the filter applies.",
            "type":"string"
        },
        "filterName":{
            "description":"The name of the filter.",
            "type":"string"
        },
        "filterNo":{
            "description":"The filter number which uniquely identifies the filter.",
            "type":"integer"
        },
        "filterOperators":{
            "items":{
                "description":"The operators used for the filter.",
                "type":"integer"
            },
            "type":"array"
        },
        "filterPath":{
            "description":"The filter path.",
            "type":"string"
        },
        "filterType":{
            "description":"The filter type.",
            "type":"integer"
        },
        "measurementUnit":{
            "description":"The measurement unit for the filter.",
            "type":"string"
        },
        "possibleValues":{
            "items":{
                "description":"A list of possible values for the filter.",
                "type":"string"
            },
            "type":"array"
        },
        "values":{
            "items":{
                "description":"A list of selected values for the filter.",
                "type":"string"
            },
            "type":"array"
        },
        "sectionName":{
            "description":"The section name.",
            "type":"string"
        },
        "sectionNo":{
            "description":"The section number.",
            "type":"integer"
        },
        "selectedByDefault":{
            "description":"An explanation about the purpose of the instance.",
            "type":"boolean"
        }
    }
}

Nested Schema : defaultValues

Type: array

Show Source

• [0]: integer
  The default values to be applied for the filter.

{
    "items":{
        "description":"The default values to be applied for the filter.",
        "type":"integer"
    },
    "type":"array"
}

Nested Schema : filterOperators

Type: array

Show Source

• [0]: integer
  The operators used for the filter.

{
    "items":{
        "description":"The operators used for the filter.",
        "type":"integer"
    },
    "type":"array"
}

Nested Schema : possibleValues

Type: array

Show Source

• [0]: string
  A list of possible values for the filter.

{
    "items":{
        "description":"A list of possible values for the filter.",
        "type":"string"
    },
    "type":"array"
}

Nested Schema : values

Type: array

Show Source

• [0]: string
  A list of selected values for the filter.

{
    "items":{
        "description":"A list of selected values for the filter.",
        "type":"string"
    },
    "type":"array"
}

Response

Supported Media Types

• application/json

200 Response

Returns the application list as per the ListMetaInfo information provided in the request. The API supports pagination and returns no more than the number of applications specified in the 'Maximum Number of Items in List' setting in Recruiting Center.

Body ()

The response for the list API.

Root Schema : ListData

Type: object

The response for the list API.

Show Source

• items: array items

{
    "description":"The response for the list API.",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CollectionResource"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• [0]: object Collection Resource
  Title: Collection Resource

  Base collection resource schema definition.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CollectionResource"
    }
}

Nested Schema : Collection Resource

Type: object

Title: Collection Resource

Base collection resource schema definition.

Show Source

• count: integer(int32)
  The total number of items in the current response.
• items: array items
• limit: integer(int32)
  The actual page size used by the server. This may be different to what the client requested.
• offset: integer(int32)
  The actual index from which items are returned.
• totalResults: integer(int32)
  Total number of items that satisfy the criteria specified by the client.

{
    "title":"Collection Resource",
    "description":"Base collection resource schema definition.",
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of items that satisfy the criteria specified by the client."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"The actual page size used by the server. This may be different to what the client requested."
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"The total number of items in the current response."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"The actual index from which items are returned."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SummaryItem"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• [0]: object SummaryItem

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SummaryItem"
    }
}

Nested Schema : SummaryItem

Type: object

Show Source

• action: string
  operation.
• attributes: array attributes
  Key value collection of important attributes of the entities in the list
• children: array children
  Sub items of the summary item. Not used in the APIs now.
• groups: array groups
  Group information. Not used in the APIs now.
• links: array links

{
    "type":"object",
    "properties":{
        "action":{
            "description":"operation.",
            "type":"string"
        },
        "attributes":{
            "type":"array",
            "description":"Key value collection of important attributes of the entities in the list",
            "items":{
                "type":"object",
                "additionalProperties":true
            }
        },
        "children":{
            "type":"array",
            "description":"Sub items of the summary item. Not used in the APIs now.",
            "items":{
            }
        },
        "groups":{
            "type":"array",
            "description":"Group information. Not used in the APIs now.",
            "items":{
                "type":"string"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : attributes

Type: array

Key value collection of important attributes of the entities in the list

Show Source

• [0]: object items
  Additional Properties Allowed: true

{
    "type":"array",
    "description":"Key value collection of important attributes of the entities in the list",
    "items":{
        "type":"object",
        "additionalProperties":true
    }
}

Nested Schema : children

Type: array

Sub items of the summary item. Not used in the APIs now.

Show Source

• [0]:

{
    "type":"array",
    "description":"Sub items of the summary item. Not used in the APIs now.",
    "items":{
    }
}

Nested Schema : groups

Type: array

Group information. Not used in the APIs now.

Show Source

• [0]: string

{
    "type":"array",
    "description":"Group information. Not used in the APIs now.",
    "items":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• [0]: object Link
  Simple link representation. Used in list API.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed: true

Nested Schema : Link

Type: object

Simple link representation. Used in list API.

Show Source

• href: string
  href uri
• rel: string
  Type of the link relation. For example, self.
• view: string
  View information of the link. Not used in the APIs now.

{
    "type":"object",
    "description":"Simple link representation. Used in list API.",
    "properties":{
        "href":{
            "description":"href uri",
            "type":"string"
        },
        "rel":{
            "description":"Type of the link relation. For example, self.",
            "type":"string"
        },
        "view":{
            "description":"View information of the link. Not used in the APIs now.",
            "type":"string"
        }
    }
}

400 Response

The error code represents an invalid request. For example: The specified context ID or format ID is invalid.

Body ()

Root Schema : Represents an error response.

Type: object

Title: Represents an error response.

Represents an error response.

Show Source

• additionalProperties: object additionalProperties
  Any additional properties apart from code, message or description.
• errors: array errors

{
    "title":"Represents an error response.",
    "description":"Represents an error response.",
    "type":"object",
    "properties":{
        "errors":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Error"
            }
        },
        "additionalProperties":{
            "description":"Any additional properties apart from code, message or description.",
            "type":"object"
        }
    }
}

Nested Schema : additionalProperties

Type: object

Any additional properties apart from code, message or description.

Nested Schema : errors

Type: array

Show Source

• [0]: object Represents a generic error.
  Title: Represents a generic error.

  Represents a generic error.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Nested Schema : Represents a generic error.

Type: object

Title: Represents a generic error.

Represents a generic error.

Show Source

• code: integer
  Represents the error code.
• description: string
  The error description text.
• message: string
  The actual error message.

{
    "title":"Represents a generic error.",
    "description":"Represents a generic error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"integer",
            "description":"Represents the error code."
        },
        "message":{
            "type":"string",
            "description":"The actual error message."
        },
        "description":{
            "type":"string",
            "description":"The error description text."
        }
    }
}

Default Response

Unexpected error.