Skip to main content

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
MethodGET
URL or Endpoint/api/projects/projectId/wrappers
HeadersAuthorization
Parametersorder,search, insertedDate, page, take, projectId
BodyNot Applicable

The description of the URL parameter is as follows:

projectId Parameter
URL Parameter NameprojectId
MandatoryYes
Typestring
DescriptionUnique Id of the project.

The description of the parameters is as follows:

Parameter NameMandatoryTypeDescription
orderNostringSpecifies the sorting order.
searchNostringSearch a specific wrapper
insertedDateNostring($date-time)Date when the wrapper was inserted.
pageNointeger($int32)A specific page with wrappers.
takeNointeger($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 NameTypeDescription
successboolIf the response is successful, it will return true. Otherwise, it will return false.
errorsarray[string]Indicates if there was an error.
messagesarray[string]Returns any messages from the back-end.
resultobjectThe main object containing the paginated result details.
currentPageintegerThe current page number being returned.
totalPagesintegerTotal number of available pages.
pageSizeintegerThe number of items displayed per page.
totalCountintegerThe total number of items across all pages.
itemsarray[object]An array containing the list of items for the current page.
publicIdstringThe unique public identifier of the item.
namestringThe name of the item.
lastUpdatestring (DateTime)The date and time when the item was last updated.
resultInfonullableReturns additional information about the result (if any).
statusCodeintegerReturns 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