Jump to

• Request
• Response

Task Users search Based On Criteria

post

/api/v1/tasks/{taskId}/users/.search

Request

Path Parameters

• taskId: string

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• page(optional): object page
• recordCount(optional): integer
• searchFilters(optional): string
• sort(optional): object sort

{
    "properties":{
        "page":{
            "required":[
                "offset",
                "limit"
            ],
            "properties":{
                "offset":{
                    "type":"number"
                },
                "limit":{
                    "type":"number"
                }
            },
            "type":"object"
        },
        "sort":{
            "required":[
                "sortBy",
                "sortOrder"
            ],
            "properties":{
                "sortBy":{
                    "type":"string"
                },
                "sortOrder":{
                    "type":"string"
                }
            },
            "type":"object"
        },
        "searchFilters":{
            "type":"string"
        },
        "recordCount":{
            "type":"integer"
        }
    }
}

Nested Schema : page

Type: object

Show Source

• limit: number
• offset: number

{
    "required":[
        "offset",
        "limit"
    ],
    "properties":{
        "offset":{
            "type":"number"
        },
        "limit":{
            "type":"number"
        }
    },
    "type":"object"
}

Nested Schema : sort

Type: object

Show Source

• sortBy: string
• sortOrder: string

{
    "required":[
        "sortBy",
        "sortOrder"
    ],
    "properties":{
        "sortBy":{
            "type":"string"
        },
        "sortOrder":{
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful Operation

Body ()

Root Schema : GenericListResponse

Type: object

Show Source

• count(optional): integer
• hasMore(optional): boolean
• items(optional): array items
• limit(optional): integer
• offset(optional): integer
• recordCount(optional): integer

{
    "properties":{
        "limit":{
            "type":"integer"
        },
        "offset":{
            "type":"integer"
        },
        "recordCount":{
            "type":"integer"
        },
        "count":{
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "items":{
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top