Class LinkResource

Index

Constructors

Methods

Constructors

constructor

new LinkResource(http: HttpClient): LinkResource
Parameters
- http: HttpClient
Returns LinkResource
- Defined in packages/sdk/src/v1/resources/tasks.ts:239

Methods

create

create(
task: string,
input: { external_scope: string; object_id: string; object_type: string },
): Promise<Record<string, unknown>>
Add an external link to a task
Parameters
- task: string
  Task ID (tsk_...).
- input: { external_scope: string; object_id: string; object_type: string }
  Request body.
  - external_scope: string
    External container ID.
  - object_id: string
    External object ID.
  - object_type: string
    External object type.
Returns Promise<Record<string, unknown>>
The created external link.
- Defined in packages/sdk/src/v1/resources/tasks.ts:259

remove

remove(task: string): Promise<void>
Remove an external link from a task
Parameters
- task: string
  Task ID (tsk_...).
Returns Promise<void>
HTTP 204 on success.
- Defined in packages/sdk/src/v1/resources/tasks.ts:246