GET Wrapper with Pagniation
TThe following table provides information about the GET
method used to retrieve all wrappers as a list, based on specified request parameters.
GET Wrapper with Pagniation | |
---|---|
Method | GET |
URL or Endpoint | /api/projects/projectId /wrappers |
Headers | Authorization |
Parameters | order,search, insertedDate, page, take, projectId |
Body | Not Applicable |
The description of the URL parameter is as follows:
projectId Parameter | |
---|---|
URL Parameter Name | projectId |
Mandatory | Yes |
Type | string |
Description | Unique Id of the project. |
The description of the parameters is as follows:
Parameter Name | Mandatory | Type | Description |
---|---|---|---|
order | No | string | Specifies the sorting order. |
search | No | string | Search a specific wrapper |
insertedDate | No | string($date-time) | Date when the wrapper was inserted. |
page | No | integer($int32) | A specific page with wrappers. |
take | No | integer($int32) | Number of wrappers to take. |
Request Body
The GET
method doesn't contain a request body.
Response
{
"success": true,
"errors": [],
"messages": [],
"result": {
"currentPage": 1,
"totalPages": 1,
"pageSize": 10,
"totalCount": 1,
"items": [
{
"publicId": "publicId",
"name": "name",
"lastUpdate": "2024-10-15T13:40:24.6218402"
}
]
},
"resultInfo": null,
"statusCode": 200
}
Information about the fields that appear when you receive the response are displayed in the table below.
Field Name | Type | Description |
---|---|---|
success | bool | If the response is successful, it will return true. Otherwise, it will return false. |
errors | array[string] | Indicates if there was an error. |
messages | array[string] | Returns any messages from the back-end. |
result | object | The main object containing the paginated result details. |
currentPage | integer | The current page number being returned. |
totalPages | integer | Total number of available pages. |
pageSize | integer | The number of items displayed per page. |
totalCount | integer | The total number of items across all pages. |
items | array[object] | An array containing the list of items for the current page. |
publicId | string | The unique public identifier of the item. |
name | string | The name of the item. |
lastUpdate | string (DateTime) | The date and time when the item was last updated. |
resultInfo | nullable | Returns additional information about the result (if any). |
statusCode | integer | Returns the HTTP status code (e.g., 200). |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed