> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # ListAsyncJobItems # Package: asyncJob # Namespace: AsyncJobService # Method link: https://dev.wix.com/docs/api-reference/business-management/async-job/list-async-job-items.md ## Permission Scopes: READ ASYNC JOBS: SCOPE.ASYNC_JOB.READ ## Introduction Retrieves a list of job items. --- ## REST API ### Schema ``` Method: listAsyncJobItems Description: Retrieves a list of job items. URL: https://www.wixapis.com/v1/async-jobs/{jobId}/items Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: jobId Method parameters: param name: jobId | type: none | required: true param name: paging | type: CursorPaging - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. param name: statusFilter | type: StatusFilter - enum: ALL - Return all items. FAILED_ONLY - Return only failed items. SUCCESSFUL_ONLY - Return only successful items. Return type: ListAsyncJobItemsResponse - name: results | type: array | description: Job items. - name: id | type: string | description: Job item GUID. - name: data | type: object | description: Job item data, as passed by the originating service. - name: entityId | type: string | description: GUID of the entity being processed, as passed by the originating service. - name: success | type: boolean | description: Whether the job item was processed successfully. - name: error | type: ApplicationError | description: Error that prevented the item from being processed, if relevant. - name: code | type: string | description: Error code. - name: description | type: string | description: Description of the error. - name: data | type: object | description: Data related to the error. - name: pagingMetadata | type: PagingMetadataV2 | description: Paging metadata. - name: count | type: integer | description: Number of items returned in the response. - name: cursors | type: Cursors | description: Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. - name: next | type: string | description: Cursor pointing to next page in the list of results. - name: prev | type: string | description: Cursor pointing to previous page in the list of results. ``` ### Examples ### List Async job Items ```curl curl -X GET \ 'https://www.wixapis.com/async-jobs/v1/async-jobs/076e0505-6944-4645-a248-80b197ee9cfd/items?limit=10' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.asyncJob.AsyncJobService.listAsyncJobItems(jobId, options) Description: Retrieves a list of job items. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: jobId Method parameters: param name: jobId | type: string | description: Job GUID. | required: true param name: options | type: ListAsyncJobItemsOptions none - name: paging | type: CursorPaging | description: Pagination options. - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: statusFilter | type: StatusFilter | description: async job item status filter. - enum: - ALL: Return all items. - FAILED_ONLY: Return only failed items. - SUCCESSFUL_ONLY: Return only successful items. Return type: PROMISE - name: results | type: array | description: Job items. - name: _id | type: string | description: Job item GUID. - name: data | type: object | description: Job item data, as passed by the originating service. - name: entityId | type: string | description: GUID of the entity being processed, as passed by the originating service. - name: success | type: boolean | description: Whether the job item was processed successfully. - name: error | type: ApplicationError | description: Error that prevented the item from being processed, if relevant. - name: code | type: string | description: Error code. - name: description | type: string | description: Description of the error. - name: data | type: object | description: Data related to the error. - name: pagingMetadata | type: PagingMetadataV2 | description: Paging metadata. - name: count | type: integer | description: Number of items returned in the response. - name: cursors | type: Cursors | description: Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. - name: next | type: string | description: Cursor pointing to next page in the list of results. - name: prev | type: string | description: Cursor pointing to previous page in the list of results. ``` ### Examples ### listAsyncJobItems ```javascript import { asyncJobs } from '@wix/async-jobs'; async function listAsyncJobItems(jobId,options) { const response = await asyncJobs.listAsyncJobItems(jobId,options); }; ``` ### listAsyncJobItems (with elevated permissions) ```javascript import { asyncJobs } from '@wix/async-jobs'; import { auth } from '@wix/essentials'; async function myListAsyncJobItemsMethod(jobId,options) { const elevatedListAsyncJobItems = auth.elevate(asyncJobs.listAsyncJobItems); const response = await elevatedListAsyncJobItems(jobId,options); } ``` ### listAsyncJobItems (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { asyncJobs } from '@wix/async-jobs'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { asyncJobs }, // Include the auth strategy and host as relevant }); async function listAsyncJobItems(jobId,options) { const response = await myWixClient.asyncJobs.listAsyncJobItems(jobId,options); }; ``` ---