Class AssetsService

See

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-assets

Hierarchy

CommonHttpService
- AssetsService

Index

Constructors

Methods

getAssetsWorkspaces getInsightWorkspaces initialize

Constructors

constructor

new AssetsService(getClientInstance): AssetsService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns AssetsService
Inherited from CommonHttpService.constructor

Methods

getAssetsWorkspaces

getAssetsWorkspaces(params?): Promise<PagedDtoAssetsWorkspaceDto>
Returns a list of Assets workspace IDs. Include a workspace ID in the path to access the Assets REST APIs.

Permissions required: Any
Parameters
- params: {
  limit?: number;
  start?: number;
  } = {}
  - Optionallimit?: number
    The maximum number of workspace IDs to return per page. Default: 50 See the Pagination section for more details.
  - Optionalstart?: number
    The starting index of the returned workspace IDs. Base index: 0 See the Pagination section for more details.
Returns Promise<PagedDtoAssetsWorkspaceDto>
Returned if the request is successful.

example:
```
{
  "_expands": [],
  "size": 1,
  "start": 1,
  "limit": 1,
  "isLastPage": true,
  "_links": {
    "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
    "context": "context",
    "next": "https://your-domain.atlassian.net/rest/servicedeskapi/rest/servicedeskapi/assets/workspace?start=2&limit=1",
    "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/rest/servicedeskapi/assets/workspace?start=0&limit=1"
  },
  "values": [
    {
      "workspaceId": "1060ba0e-178b-4e0e-g0h1-jedb02cccb5f"
    }
  ]
}
```
Path
GET /rest/servicedeskapi/assets/workspace

See
https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-assets#api-rest-servicedeskapi-assets-workspace-get

getInsightWorkspaces

getInsightWorkspaces(params?): Promise<PagedDtoInsightWorkspaceDto>
This endpoint is deprecated, please use /assets/workspace/.
Parameters
- params: {
  limit?: number;
  start?: number;
  } = {}
  - Optionallimit?: number
  - Optionalstart?: number
Returns Promise<PagedDtoInsightWorkspaceDto>
200 response

Path
GET /rest/servicedeskapi/insight/workspace

See
https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-assets#api-rest-servicedeskapi-insight-workspace-get

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize