SeismicplannerClient

Classes

CommentQueryResponse dataclass

CommentQueryResponse(*, count: Optional[int] = None, cursor: Optional[str] = None, items: Optional[List[Comment | Mapping[str, Any]]] = None, limit: Optional[int] = None, meta: Optional[Meta | Mapping[str, Any]] = None)

Response for Get comments

Attributes

count class-attribute instance-attribute

count: Optional[int] = dataclass_field(default=None, kw_only=True)

Number of records returned

cursor class-attribute instance-attribute

cursor: Optional[str] = dataclass_field(default=None, kw_only=True)

Cursor used for pagination

items class-attribute instance-attribute

items: Optional[List[Comment | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of items in the response

limit class-attribute instance-attribute

limit: Optional[int] = dataclass_field(default=None, kw_only=True)

Number to limit records

Comment dataclass

Comment(*, annotation_payload: Optional[str] = None, annotation_type: Optional[str] = None, comment_content: Optional[str] = None, created_at: Optional[str] = None, creator_id: Optional[str] = None, id: Optional[str] = None, is_resolved: Optional[bool] = None, node_id: Optional[str] = None, node_type: Optional[str] = None, page_index: Optional[str] = None, parent_id: Optional[str] = None, reply_count: Optional[int] = None, space_id: Optional[str] = None, updated_at: Optional[str] = None)

Response for Create comment

Attributes

created_at class-attribute instance-attribute

created_at: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdAt'})

Date string of date created

creator_id class-attribute instance-attribute

creator_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'creatorId'})

User ID of the creator

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Comment ID

is_resolved class-attribute instance-attribute

is_resolved: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isResolved'})

True/false on whether the comment is resolved

node_id class-attribute instance-attribute

node_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nodeId'})

Node ID

node_type class-attribute instance-attribute

node_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nodeType'})

Node type of the comment

page_index class-attribute instance-attribute

page_index: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageIndex'})

Number page index

parent_id class-attribute instance-attribute

parent_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'parentId'})

Parent comment ID

reply_count class-attribute instance-attribute

reply_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'replyCount'})

Number of replies

space_id class-attribute instance-attribute

space_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'spaceId'})

Space ID

updated_at class-attribute instance-attribute

updated_at: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'updatedAt'})

Date string of updated date

PlannerProjectQueryResponse dataclass

PlannerProjectQueryResponse(*, count: Optional[int] = None, cursor: Optional[str] = None, items: Optional[List[PlannerProject | Mapping[str, Any]]] = None, limit: Optional[int] = None, meta: Optional[Meta | Mapping[str, Any]] = None)

Response for Get projects

Attributes

count class-attribute instance-attribute

count: Optional[int] = dataclass_field(default=None, kw_only=True)

Number of records returned

cursor class-attribute instance-attribute

cursor: Optional[str] = dataclass_field(default=None, kw_only=True)

Cursor used for pagination

items class-attribute instance-attribute

items: Optional[List[PlannerProject | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of project items in the response

limit class-attribute instance-attribute

limit: Optional[int] = dataclass_field(default=None, kw_only=True)

Number to limit records

AsyncOperationResponse dataclass

AsyncOperationResponse(*, async_operation_ids: Optional[List[str]] = None)

Response for Delete projects

Attributes

async_operation_ids class-attribute instance-attribute

async_operation_ids: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'asyncOperationIds'})

List of async action IDs

PlannerProject dataclass

PlannerProject(*, actual_duration: Optional[int] = None, actual_end_date: Optional[str] = None, actual_start_date: Optional[str] = None, associated_nodes: Optional[List[ProjectAssociatedNodes | Mapping[str, Any]]] = None, associations: Optional[List[Association | Mapping[str, Any]]] = None, copy_from: Optional[str] = None, created_at: Optional[str] = None, creator_id: Optional[str] = None, custom_properties: Optional[List[CustomPropertyValues | Mapping[str, Any]]] = None, description: Optional[str] = None, followers: Optional[List[Follower | Mapping[str, Any]]] = None, id: Optional[str] = None, is_active: Optional[bool] = None, is_template: Optional[bool] = None, manager_id: Optional[str] = None, max_rank: Optional[str] = None, min_rank: Optional[str] = None, planned_duration: Optional[int] = None, planned_end_date: Optional[str] = None, planned_start_date: Optional[str] = None, space_id: Optional[str] = None, template_id: Optional[str] = None, title: Optional[str] = None, updated_at: Optional[str] = None, works: Optional[List[PlannerTask | Mapping[str, Any]]] = None)

Response for Create project

Attributes

actual_duration class-attribute instance-attribute

actual_duration: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'actualDuration'})

Calculated actual duration in days

actual_end_date class-attribute instance-attribute

actual_end_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'actualEndDate'})

Calculated end date from when the project actually ended

actual_start_date class-attribute instance-attribute

actual_start_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'actualStartDate'})

Calculated start date from when the project actually started

associated_nodes class-attribute instance-attribute

associated_nodes: Optional[List[ProjectAssociatedNodes | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'associatedNodes'})

List of association data

associations class-attribute instance-attribute

associations: Optional[List[Association | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of associations (Library content)

copy_from class-attribute instance-attribute

copy_from: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'copyFrom'})

Project ID the project is copied from

created_at class-attribute instance-attribute

created_at: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdAt'})

Date string of created date

creator_id class-attribute instance-attribute

creator_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'creatorId'})

User ID of creator

custom_properties class-attribute instance-attribute

custom_properties: Optional[List[CustomPropertyValues | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'customProperties'})

List of custom properties

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

Description of project

followers class-attribute instance-attribute

followers: Optional[List[Follower | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of followers

is_active class-attribute instance-attribute

is_active: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isActive'})

Indicator on if a project is active or not

is_template class-attribute instance-attribute

is_template: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isTemplate'})

Indicator on if the project is a template or not

manager_id class-attribute instance-attribute

manager_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'managerId'})

User ID of project manager

max_rank class-attribute instance-attribute

max_rank: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'maxRank'})

Maximum rank number

min_rank class-attribute instance-attribute

min_rank: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'minRank'})

Minimum rank number

planned_duration class-attribute instance-attribute

planned_duration: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedDuration'})

Planned duration in days

planned_end_date class-attribute instance-attribute

planned_end_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedEndDate'})

Date string of planned end date

planned_start_date class-attribute instance-attribute

planned_start_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedStartDate'})

Date string of planned start date

template_id class-attribute instance-attribute

template_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'templateId'})

Template ID the the project was created from

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

Title of project

updated_at class-attribute instance-attribute

updated_at: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'updatedAt'})

Date project was last updated

works class-attribute instance-attribute

works: Optional[List[PlannerTask | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of tasks and requests

PlannerRequestQueryResponse dataclass

PlannerRequestQueryResponse(*, count: Optional[int] = None, cursor: Optional[str] = None, items: Optional[List[PlannerRequest | Mapping[str, Any]]] = None, limit: Optional[int] = None, meta: Optional[Meta | Mapping[str, Any]] = None)

Response for Get requests

Attributes

count class-attribute instance-attribute

count: Optional[int] = dataclass_field(default=None, kw_only=True)

Number of records returned

cursor class-attribute instance-attribute

cursor: Optional[str] = dataclass_field(default=None, kw_only=True)

Cursor used for pagination

items class-attribute instance-attribute

items: Optional[List[PlannerRequest | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of request objects in the response

limit class-attribute instance-attribute

limit: Optional[int] = dataclass_field(default=None, kw_only=True)

Number to limit records

PlannerRequest dataclass

PlannerRequest(*, assignee_id: Optional[str] = None, assigner_id: Optional[str] = None, associations: Optional[List[Association | Mapping[str, Any]]] = None, content_refs: Optional[List[ContentRef | Mapping[str, Any]]] = None, created_at: Optional[str] = None, creator_id: Optional[str] = None, custom_properties: Optional[List[CustomPropertyValues | Mapping[str, Any]]] = None, followers: Optional[List[Follower | Mapping[str, Any]]] = None, form_ref: Optional[Any] = None, id: Optional[str] = None, note: Optional[str] = None, planned_duration: Optional[int] = None, planned_end_date: Optional[str] = None, planned_start_date: Optional[str] = None, priority: Optional[str] = None, project_id: Optional[str] = None, rank: Optional[str] = None, request_form_custom_property_option: Optional[RequestFormCustomProperties | Mapping[str, Any]] = None, space_id: Optional[str] = None, status_schema_id: Optional[str] = None, step_id: Optional[int] = None, title: Optional[str] = None, updated_at: Optional[str] = None)

Response for Create request

Attributes

assignee_id class-attribute instance-attribute

assignee_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'assigneeId'})

User ID of the assignee

assigner_id class-attribute instance-attribute

assigner_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'assignerId'})

User ID of the assigner

associations class-attribute instance-attribute

associations: Optional[List[Association | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of associations (Library content)

content_refs class-attribute instance-attribute

content_refs: Optional[List[ContentRef | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'contentRefs'})

List of content references (WorkSpace and DocCenter content)

created_at class-attribute instance-attribute

created_at: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdAt'})

Date string for created date

creator_id class-attribute instance-attribute

creator_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'creatorId'})

User ID of the creator

custom_properties class-attribute instance-attribute

custom_properties: Optional[List[CustomPropertyValues | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'customProperties'})

List of custom properties

followers class-attribute instance-attribute

followers: Optional[List[Follower | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of followers

form_ref class-attribute instance-attribute

form_ref: Optional[Any] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'formRef'})

Form reference object

note class-attribute instance-attribute

note: Optional[str] = dataclass_field(default=None, kw_only=True)

Note for notifications on status changes

planned_duration class-attribute instance-attribute

planned_duration: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedDuration'})

Planned duration in days

planned_end_date class-attribute instance-attribute

planned_end_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedEndDate'})

Date string of planned end date

planned_start_date class-attribute instance-attribute

planned_start_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedStartDate'})

Date string of planned start date

priority class-attribute instance-attribute

priority: Optional[str] = dataclass_field(default=None, kw_only=True)

Priority value

project_id class-attribute instance-attribute

project_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'projectId'})

Project ID of the project the request is associated with

rank class-attribute instance-attribute

rank: Optional[str] = dataclass_field(default=None, kw_only=True)

Rank of request in request list

step_id class-attribute instance-attribute

step_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'stepId'})

Step ID indicating the status value

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

Title of the request

updated_at class-attribute instance-attribute

updated_at: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'updatedAt'})

Date the request was last updated

StatusSchemaQueryResponse dataclass

StatusSchemaQueryResponse(*, count: Optional[int] = None, cursor: Optional[str] = None, items: Optional[List[StatusSchema | Mapping[str, Any]]] = None, limit: Optional[int] = None, meta: Optional[Meta | Mapping[str, Any]] = None)

Response for Get status schemas

Attributes

count class-attribute instance-attribute

count: Optional[int] = dataclass_field(default=None, kw_only=True)

Number of records returned

cursor class-attribute instance-attribute

cursor: Optional[str] = dataclass_field(default=None, kw_only=True)

Cursor used for pagination

items class-attribute instance-attribute

items: Optional[List[StatusSchema | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of status schema objects in the response

limit class-attribute instance-attribute

limit: Optional[int] = dataclass_field(default=None, kw_only=True)

Number to limit records

StatusSchema dataclass

StatusSchema(*, created_at: Optional[str] = None, creator_id: Optional[str] = None, id: Optional[str] = None, is_default: Optional[bool] = None, name: Optional[str] = None, space_id: Optional[str] = None, steps: Optional[List[str]] = None, transitions: Optional[List[List[int]]] = None, type_: Optional[str] = None, updated_at: Optional[str] = None)

Response for Get status schema

Attributes

created_at class-attribute instance-attribute

created_at: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdAt'})

Date string of created date

creator_id class-attribute instance-attribute

creator_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'creatorId'})

User ID of creator

is_default class-attribute instance-attribute

is_default: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isDefault'})

Indicator on if the status schema is the default schema

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Name of status schema

steps class-attribute instance-attribute

steps: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

List of steps and their values

transitions class-attribute instance-attribute

transitions: Optional[List[List[int]]] = dataclass_field(default=None, kw_only=True)

List of transition rules

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'type'})

Node type the status schema can be used for

updated_at class-attribute instance-attribute

updated_at: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'updatedAt'})

Date the status schema was last updated

PlannerTaskQueryResponse dataclass

PlannerTaskQueryResponse(*, count: Optional[int] = None, cursor: Optional[str] = None, items: Optional[List[PlannerTask | Mapping[str, Any]]] = None, limit: Optional[int] = None, meta: Optional[Meta | Mapping[str, Any]] = None)

Response for Get tasks

Attributes

count class-attribute instance-attribute

count: Optional[int] = dataclass_field(default=None, kw_only=True)

Number of records returned

cursor class-attribute instance-attribute

cursor: Optional[str] = dataclass_field(default=None, kw_only=True)

Cursor used for pagination

items class-attribute instance-attribute

items: Optional[List[PlannerTask | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of task objects in the response

limit class-attribute instance-attribute

limit: Optional[int] = dataclass_field(default=None, kw_only=True)

Number to limit records

PlannerTask dataclass

PlannerTask(*, actual_duration: Optional[int] = None, actual_end_date: Optional[str] = None, actual_start_date: Optional[str] = None, assignee_id: Optional[str] = None, assigner_id: Optional[str] = None, associations: Optional[List[Association | Mapping[str, Any]]] = None, copy_from: Optional[str] = None, created_at: Optional[str] = None, creator_id: Optional[str] = None, custom_properties: Optional[List[CustomPropertyValues | Mapping[str, Any]]] = None, description: Optional[str] = None, followers: Optional[List[Follower | Mapping[str, Any]]] = None, id: Optional[str] = None, is_template: Optional[bool] = None, max_rank: Optional[str] = None, min_rank: Optional[str] = None, parent_id: Optional[str] = None, planned_duration: Optional[int] = None, planned_end_date: Optional[str] = None, planned_start_date: Optional[str] = None, priority: Optional[str] = None, project_id: Optional[str] = None, rank: Optional[str] = None, space_id: Optional[str] = None, status_schema_id: Optional[str] = None, step_id: Optional[int] = None, sub_task_ids: Optional[List[str]] = None, sub_tasks: Optional[List[PlannerSubTask | Mapping[str, Any]]] = None, template_id: Optional[str] = None, title: Optional[str] = None, type_: Optional[str] = None, updated_at: Optional[str] = None)

Response for Create task

Attributes

actual_duration class-attribute instance-attribute

actual_duration: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'actualDuration'})

Calculated actual duration in days

actual_end_date class-attribute instance-attribute

actual_end_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'actualEndDate'})

Date when work on the task was completed

actual_start_date class-attribute instance-attribute

actual_start_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'actualStartDate'})

Date when work on the task started

assignee_id class-attribute instance-attribute

assignee_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'assigneeId'})

User ID of assignee

assigner_id class-attribute instance-attribute

assigner_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'assignerId'})

User ID of the last user to add an assignee

associations class-attribute instance-attribute

associations: Optional[List[Association | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of associations on a task

copy_from class-attribute instance-attribute

copy_from: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'copyFrom'})

Task ID that task was copied from

created_at class-attribute instance-attribute

created_at: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdAt'})

Date the task was created

creator_id class-attribute instance-attribute

creator_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'creatorId'})

User ID of creator

custom_properties class-attribute instance-attribute

custom_properties: Optional[List[CustomPropertyValues | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'customProperties'})

List of custom properties on a task

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

Description of task

followers class-attribute instance-attribute

followers: Optional[List[Follower | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of followers on a task

is_template class-attribute instance-attribute

is_template: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isTemplate'})

Indicates if a task is part of a template

max_rank class-attribute instance-attribute

max_rank: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'maxRank'})

Maximum rank

min_rank class-attribute instance-attribute

min_rank: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'minRank'})

Minimum rank

parent_id class-attribute instance-attribute

parent_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'parentId'})

Task ID of parent if task is a subtask

planned_duration class-attribute instance-attribute

planned_duration: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedDuration'})

Planned duration in days

planned_end_date class-attribute instance-attribute

planned_end_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedEndDate'})

Date string of planned end date (due date)

planned_start_date class-attribute instance-attribute

planned_start_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedStartDate'})

Date string of planned start date

priority class-attribute instance-attribute

priority: Optional[str] = dataclass_field(default=None, kw_only=True)

Priority value

project_id class-attribute instance-attribute

project_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'projectId'})

Project ID the task belongs to

rank class-attribute instance-attribute

rank: Optional[str] = dataclass_field(default=None, kw_only=True)

Rank of task in a task list

step_id class-attribute instance-attribute

step_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'stepId'})

Id of step in status schema

sub_task_ids class-attribute instance-attribute

sub_task_ids: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'subTaskIds'})

List of subtask IDs

sub_tasks class-attribute instance-attribute

sub_tasks: Optional[List[PlannerSubTask | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'subTasks'})

List of subtasks on the task

template_id class-attribute instance-attribute

template_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'templateId'})

Template ID of the template the task belongs to

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

Title of task

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'type'})

Type of task

updated_at class-attribute instance-attribute

updated_at: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'updatedAt'})

Date the task was last updated

Association dataclass

Association(*, description: Optional[str] = None, name: Optional[str] = None, node_guid: Optional[str] = None, node_id: Optional[str] = None, node_type: Optional[str] = None, space_guid: Optional[str] = None, space_id: Optional[str] = None)

Definition: Association

Attributes

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

Description of association

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Name of association

node_guid class-attribute instance-attribute

node_guid: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nodeGuid'})

Longer GUID format

node_id class-attribute instance-attribute

node_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nodeId'})

Node ID

node_type class-attribute instance-attribute

node_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nodeType'})

Node type of the association

space_guid class-attribute instance-attribute

space_guid: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'spaceGuid'})

Longer GUID format

space_id class-attribute instance-attribute

space_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'spaceId'})

Space ID

AssociationReq dataclass

AssociationReq(*, node_id: Optional[str] = None, node_type: Optional[str] = None, space_id: Optional[str] = None)

Definition: AssociationReq

Attributes

node_id class-attribute instance-attribute

node_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nodeId'})

Node ID

node_type class-attribute instance-attribute

node_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nodeType'})

Node type of the association

space_id class-attribute instance-attribute

space_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'spaceId'})

Space ID

ContentRef dataclass

ContentRef(*, content_id: Optional[str] = None, doc_center_full_path: Optional[str] = None, major_version: Optional[int] = None, minor_version: Optional[int] = None, modified_date: Optional[str] = None, order_no: Optional[int] = None, profile_id: Optional[str] = None, profile_version_id: Optional[str] = None, source: Optional[str] = None, team_site_id: Optional[str] = None, thumbnail_id: Optional[str] = None, version_id: Optional[str] = None)

Definition: ContentRef

Attributes

content_id class-attribute instance-attribute

content_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'contentId'})

Content ID

doc_center_full_path class-attribute instance-attribute

doc_center_full_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'docCenterFullPath'})

Full location path of where content exists in DocCenter

major_version class-attribute instance-attribute

major_version: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'majorVersion'})

Number of major version

minor_version class-attribute instance-attribute

minor_version: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'minorVersion'})

Number of minor version

modified_date class-attribute instance-attribute

modified_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'modifiedDate'})

Date the content reference was last updated

order_no class-attribute instance-attribute

order_no: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'orderNo'})

Number to indicate order

profile_id class-attribute instance-attribute

profile_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'profileId'})

Profile ID

profile_version_id class-attribute instance-attribute

profile_version_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'profileVersionId'})

Version ID of profile

source class-attribute instance-attribute

source: Optional[str] = dataclass_field(default=None, kw_only=True)

Source of content

team_site_id class-attribute instance-attribute

team_site_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'teamSiteId'})

TeamSite ID

thumbnail_id class-attribute instance-attribute

thumbnail_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'thumbnailId'})

ID for image thumbnail

version_id class-attribute instance-attribute

version_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'versionId'})

Version ID of content

CreateCommentModel dataclass

CreateCommentModel(*, annotation_payload: Optional[str] = None, annotation_type: Optional[str] = None, comment_content: Optional[str] = None, is_resolved: Optional[bool] = None)

Definition: CreateCommentModel

Attributes

annotation_type class-attribute instance-attribute

annotation_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'annotationType'})

Annotation type

comment_content class-attribute instance-attribute

comment_content: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'commentContent'})

Content of the comment

is_resolved class-attribute instance-attribute

is_resolved: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isResolved'})

True/false on whether the comment is resolved

CreateProject dataclass

CreateProject(*, associations: Optional[List[AssociationReq | Mapping[str, Any]]] = None, custom_properties: Optional[List[CustomPropertyValuesInput | Mapping[str, Any]]] = None, description: Optional[str] = None, manager_id: Optional[str] = None, planned_duration: Optional[int] = None, planned_end_date: Optional[str] = None, planned_start_date: Optional[str] = None, title: Optional[str] = None)

Definition: CreateProject

Attributes

associations class-attribute instance-attribute

associations: Optional[List[AssociationReq | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of association objects

custom_properties class-attribute instance-attribute

custom_properties: Optional[List[CustomPropertyValuesInput | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'customProperties'})

List of custom properties

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

Title of description

manager_id class-attribute instance-attribute

manager_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'managerId'})

User ID of manager

planned_duration class-attribute instance-attribute

planned_duration: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedDuration'})

Planned duration in days

planned_end_date class-attribute instance-attribute

planned_end_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedEndDate'})

Date string of end date

planned_start_date class-attribute instance-attribute

planned_start_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedStartDate'})

Date string of start date

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

Title of project

CreateRequest dataclass

CreateRequest(*, assignee_id: Optional[str] = None, associations: Optional[List[AssociationReq | Mapping[str, Any]]] = None, content_refs: Optional[List[ContentRef | Mapping[str, Any]]] = None, custom_properties: Optional[List[CustomPropertyValuesInput | Mapping[str, Any]]] = None, form_ref: Optional[Any] = None, planned_duration: Optional[int] = None, planned_end_date: Optional[str] = None, planned_start_date: Optional[str] = None, priority: Optional[str] = None, project_id: Optional[str] = None, status_schema_id: Optional[str] = None, title: Optional[str] = None)

Definition: CreateRequest

Attributes

assignee_id class-attribute instance-attribute

assignee_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'assigneeId'})

User ID of assignee

associations class-attribute instance-attribute

associations: Optional[List[AssociationReq | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of associations (Library content)

content_refs class-attribute instance-attribute

content_refs: Optional[List[ContentRef | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'contentRefs'})

List of content references (DocCenter and Workspace associations)

custom_properties class-attribute instance-attribute

custom_properties: Optional[List[CustomPropertyValuesInput | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'customProperties'})

List of custom properties

form_ref class-attribute instance-attribute

form_ref: Optional[Any] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'formRef'})

Form reference object

planned_duration class-attribute instance-attribute

planned_duration: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedDuration'})

Planned duration in days

planned_end_date class-attribute instance-attribute

planned_end_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedEndDate'})

Date string of end date

planned_start_date class-attribute instance-attribute

planned_start_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedStartDate'})

Date string of start date

priority class-attribute instance-attribute

priority: Optional[str] = dataclass_field(default=None, kw_only=True)

Priority value

project_id class-attribute instance-attribute

project_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'projectId'})

ID of project the request belongs to

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

Title of request

CreateTask dataclass

CreateTask(*, assignee_id: Optional[str] = None, associations: Optional[List[AssociationReq | Mapping[str, Any]]] = None, custom_properties: Optional[List[CustomPropertyValuesInput | Mapping[str, Any]]] = None, description: Optional[str] = None, parent_id: Optional[str] = None, planned_duration: Optional[int] = None, planned_end_date: Optional[str] = None, planned_start_date: Optional[str] = None, priority: Optional[str] = None, project_id: Optional[str] = None, title: Optional[str] = None)

Definition: CreateTask

Attributes

assignee_id class-attribute instance-attribute

assignee_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'assigneeId'})

User ID of assignee

associations class-attribute instance-attribute

associations: Optional[List[AssociationReq | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of associations (Library content)

custom_properties class-attribute instance-attribute

custom_properties: Optional[List[CustomPropertyValuesInput | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'customProperties'})

List of custom properties

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

Description of task

parent_id class-attribute instance-attribute

parent_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'parentId'})

Task ID of parent

planned_duration class-attribute instance-attribute

planned_duration: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedDuration'})

Planned duration in days

planned_end_date class-attribute instance-attribute

planned_end_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedEndDate'})

Date string of end date

planned_start_date class-attribute instance-attribute

planned_start_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedStartDate'})

Date string of start date

priority class-attribute instance-attribute

priority: Optional[str] = dataclass_field(default=None, kw_only=True)

Priority values

project_id class-attribute instance-attribute

project_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'projectId'})

ID of project the task is associated with

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

Title of task

CustomProperty dataclass

CustomProperty(*, allow_multiple_values: Optional[bool] = None, created_by_id: Optional[str] = None, has_domain_of_values: Optional[bool] = None, hint: Optional[str] = None, id: Optional[str] = None, is_required: Optional[bool] = None, last_modified_by_id: Optional[str] = None, name: Optional[str] = None, operation_setting: Optional[str] = None, order: Optional[int] = None, possible_values: Optional[List[PossibleValuesItem | Mapping[str, Any]]] = None, scope_settings: Optional[List[ScopeSettingsItemDefinition | Mapping[str, Any]]] = None, scopes: Optional[List[str]] = None, value_schema_name: Optional[str] = None, value_schema_property: Optional[ValueSchemaPropertyDefinition | Mapping[str, Any]] = None, value_type: Optional[str] = None)

Definition: CustomProperty

Attributes

allow_multiple_values class-attribute instance-attribute

allow_multiple_values: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowMultipleValues'})

Indicates if custom property allows for multiple values

created_by_id class-attribute instance-attribute

created_by_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdById'})

User ID of the creator

has_domain_of_values class-attribute instance-attribute

has_domain_of_values: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'hasDomainOfValues'})

Indicates if custom property has possible values

hint class-attribute instance-attribute

hint: Optional[str] = dataclass_field(default=None, kw_only=True)

Value that describes the hint displayed under the custom property name

is_required class-attribute instance-attribute

is_required: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isRequired'})

Indicates whether the custom property is required or not

last_modified_by_id class-attribute instance-attribute

last_modified_by_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastModifiedById'})

User ID of the user that last updated the custom property

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Name of custom property

operation_setting class-attribute instance-attribute

operation_setting: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'operationSetting'})

Object that describes settings for different operations on a custom property

order class-attribute instance-attribute

order: Optional[int] = dataclass_field(default=None, kw_only=True)

Number indicating order within custom property list

possible_values class-attribute instance-attribute

possible_values: Optional[List[PossibleValuesItem | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'possibleValues'})

List of possible values for the custom property (if applicable)

scope_settings class-attribute instance-attribute

scope_settings: Optional[List[ScopeSettingsItemDefinition | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'scopeSettings'})

Object that describes settings for different scopes on a custom property

scopes class-attribute instance-attribute

scopes: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

List of scopes

value_schema_name class-attribute instance-attribute

value_schema_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'valueSchemaName'})

Name of custom property value schema

value_type class-attribute instance-attribute

value_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'valueType'})

Type of custom property value

CustomPropertyDataDisplay dataclass

CustomPropertyDataDisplay(*, name: Optional[str] = None)

Definition: CustomPropertyDataDisplay

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Name of custom property

CustomPropertyValues dataclass

CustomPropertyValues(*, id: Optional[str] = None, localizations: Optional[Dict[str, CustomPropertyDataDisplay | Mapping[str, Any]]] = None, multiple_value: Optional[bool] = None, name: Optional[str] = None, values: Optional[List[CustomPropertyValuesValues | Mapping[str, Any]]] = None)

Definition: CustomPropertyValues

Attributes

localizations class-attribute instance-attribute

localizations: Optional[Dict[str, CustomPropertyDataDisplay | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Localization object

multiple_value class-attribute instance-attribute

multiple_value: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'multipleValue'})

Indicate if the custom property allows multiple values

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Name of custom property

values class-attribute instance-attribute

values: Optional[List[CustomPropertyValuesValues | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of custom property values

CustomPropertyValuesInput dataclass

CustomPropertyValuesInput(*, id: Optional[str] = None, values: Optional[List[CustomPropertyValuesValues | Mapping[str, Any]]] = None)

Definition: CustomPropertyValuesInput

Attributes

values class-attribute instance-attribute

values: Optional[List[CustomPropertyValuesValues | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of custom property values

CustomPropertyValuesValues dataclass

CustomPropertyValuesValues(*, id: Optional[str] = None, value: Optional[Any] = None)

Definition: CustomPropertyValuesValues

Attributes

value class-attribute instance-attribute

value: Optional[Any] = dataclass_field(default=None, kw_only=True)

Value data for custom property value

DeleteRequest dataclass

DeleteRequest(*, ids: Optional[List[str]] = None)

Definition: DeleteRequest

Attributes

ids class-attribute instance-attribute

ids: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

List of Request IDs to delete

Follower dataclass

Follower(*, id: Optional[str] = None, type_: Optional[str] = None)

Definition: Follower

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

User/User group ID of follower

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'type'})

Either user or user group follower type

Meta dataclass

Meta(*, count: Optional[int] = None, query: Optional[List[MetaQueryInfo | Mapping[str, Any]]] = None)

Definition: Meta

Attributes

count class-attribute instance-attribute

count: Optional[int] = dataclass_field(default=None, kw_only=True)

Number of records returned

query class-attribute instance-attribute

query: Optional[List[MetaQueryInfo | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Query object

MetaQueryInfo dataclass

MetaQueryInfo(*, sort: Optional[List[str]] = None)

Definition: MetaQueryInfo

Attributes

sort class-attribute instance-attribute

sort: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

Sort query

PlannerSubTask dataclass

PlannerSubTask(*, actual_duration: Optional[int] = None, actual_end_date: Optional[str] = None, actual_start_date: Optional[str] = None, assignee_id: Optional[str] = None, assigner_id: Optional[str] = None, associations: Optional[List[Association | Mapping[str, Any]]] = None, copy_from: Optional[str] = None, created_at: Optional[str] = None, creator_id: Optional[str] = None, custom_properties: Optional[List[CustomPropertyValues | Mapping[str, Any]]] = None, description: Optional[str] = None, followers: Optional[List[Follower | Mapping[str, Any]]] = None, id: Optional[str] = None, is_template: Optional[bool] = None, max_rank: Optional[str] = None, min_rank: Optional[str] = None, parent_id: Optional[str] = None, planned_duration: Optional[int] = None, planned_end_date: Optional[str] = None, planned_start_date: Optional[str] = None, priority: Optional[str] = None, project_id: Optional[str] = None, rank: Optional[str] = None, space_id: Optional[str] = None, status_schema_id: Optional[str] = None, step_id: Optional[int] = None, template_id: Optional[str] = None, title: Optional[str] = None, type_: Optional[str] = None, updated_at: Optional[str] = None)

Definition: PlannerSubTask

Attributes

actual_duration class-attribute instance-attribute

actual_duration: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'actualDuration'})

Calculated actual duration in days

actual_end_date class-attribute instance-attribute

actual_end_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'actualEndDate'})

Date when work on the task was completed

actual_start_date class-attribute instance-attribute

actual_start_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'actualStartDate'})

Date when work on the task started

assignee_id class-attribute instance-attribute

assignee_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'assigneeId'})

User ID of assignee

assigner_id class-attribute instance-attribute

assigner_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'assignerId'})

User ID of the last user to add an assignee

associations class-attribute instance-attribute

associations: Optional[List[Association | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of associations on a task

copy_from class-attribute instance-attribute

copy_from: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'copyFrom'})

Task ID that task was copied from

created_at class-attribute instance-attribute

created_at: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdAt'})

Date the task was created

creator_id class-attribute instance-attribute

creator_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'creatorId'})

User ID of creator

custom_properties class-attribute instance-attribute

custom_properties: Optional[List[CustomPropertyValues | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'customProperties'})

List of custom properties on a task

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

Description of task

followers class-attribute instance-attribute

followers: Optional[List[Follower | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of followers on a task

is_template class-attribute instance-attribute

is_template: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isTemplate'})

Indicates if a task is part of a template

max_rank class-attribute instance-attribute

max_rank: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'maxRank'})

Maximum rank

min_rank class-attribute instance-attribute

min_rank: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'minRank'})

Minimum rank

parent_id class-attribute instance-attribute

parent_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'parentId'})

Task ID of parent if task is a subtask

planned_duration class-attribute instance-attribute

planned_duration: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedDuration'})

Planned duration in days

planned_end_date class-attribute instance-attribute

planned_end_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedEndDate'})

Date string of end date (due date)

planned_start_date class-attribute instance-attribute

planned_start_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedStartDate'})

Date string of start date

priority class-attribute instance-attribute

priority: Optional[str] = dataclass_field(default=None, kw_only=True)

Priority value

project_id class-attribute instance-attribute

project_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'projectId'})

Project ID the task belongs to

rank class-attribute instance-attribute

rank: Optional[str] = dataclass_field(default=None, kw_only=True)

Rank of task in a task list

step_id class-attribute instance-attribute

step_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'stepId'})

Id of step in status schema

template_id class-attribute instance-attribute

template_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'templateId'})

Template ID of the template the task belongs to

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

Title of task

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'type'})

Type of task

updated_at class-attribute instance-attribute

updated_at: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'updatedAt'})

Date the task was last updated

PossibleValuesItem dataclass

PossibleValuesItem(*, id: Optional[str] = None, order: Optional[int] = None, value: Optional[Any] = None)

Definition: PossibleValuesItem

Attributes

order class-attribute instance-attribute

order: Optional[int] = dataclass_field(default=None, kw_only=True)

Number to indicate order

value class-attribute instance-attribute

value: Optional[Any] = dataclass_field(default=None, kw_only=True)

Actual value data

ProblemDetails dataclass

ProblemDetails(*, detail: Optional[str] = None, instance: Optional[str] = None, status: Optional[int] = None, title: Optional[str] = None, type_: Optional[str] = None)

Definition: ProblemDetails

ProjectAssociatedNodes dataclass

ProjectAssociatedNodes(*, node_id: Optional[str] = None, node_type: Optional[str] = None, space_id: Optional[str] = None)

Definition: ProjectAssociatedNodes

Attributes

node_type class-attribute instance-attribute

node_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nodeType'})

Node type of the association

RequestFormCustomProperties dataclass

RequestFormCustomProperties(*, created_at: Optional[str] = None, custom_properties: Optional[List[CustomProperty | Mapping[str, Any]]] = None)

Definition: RequestFormCustomProperties

Attributes

created_at class-attribute instance-attribute

created_at: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdAt'})

Date string of created date

custom_properties class-attribute instance-attribute

custom_properties: Optional[List[CustomProperty | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'customProperties'})

List of custom properties

ScopeSettingsItemDefinition dataclass

ScopeSettingsItemDefinition(*, is_required: Optional[bool] = None, scope: Optional[str] = None)

Definition: ScopeSettingsItemDefinition

Attributes

is_required class-attribute instance-attribute

is_required: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isRequired'})

Indicator on whether a field is required or not

scope class-attribute instance-attribute

scope: Optional[str] = dataclass_field(default=None, kw_only=True)

Type list of node types that the custom property definition belongs to

UpdateCommentModel dataclass

UpdateCommentModel(*, annotation_payload: Optional[str] = None, annotation_type: Optional[str] = None, comment_content: Optional[str] = None, is_resolved: Optional[bool] = None)

Definition: UpdateCommentModel

Attributes

comment_content class-attribute instance-attribute

comment_content: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'commentContent'})

Content of the comment

is_resolved class-attribute instance-attribute

is_resolved: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isResolved'})

True/false on whether the comment is resolved

UpdateProject dataclass

UpdateProject(*, custom_properties: Optional[List[CustomPropertyValues | Mapping[str, Any]]] = None, description: Optional[str] = None, is_active: Optional[bool] = None, manager_id: Optional[str] = None, max_rank: Optional[str] = None, min_rank: Optional[str] = None, planned_duration: Optional[int] = None, planned_end_date: Optional[str] = None, planned_start_date: Optional[str] = None, title: Optional[str] = None)

Definition: UpdateProject

Attributes

custom_properties class-attribute instance-attribute

custom_properties: Optional[List[CustomPropertyValues | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'customProperties'})

List of custom properties

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

Description of project

is_active class-attribute instance-attribute

is_active: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isActive'})

Indicator on whether a project is active?

manager_id class-attribute instance-attribute

manager_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'managerId'})

User ID of project manager

max_rank class-attribute instance-attribute

max_rank: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'maxRank'})

Maximum rank number

min_rank class-attribute instance-attribute

min_rank: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'minRank'})

Minimum rank number

planned_duration class-attribute instance-attribute

planned_duration: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedDuration'})

Planned duration in days

planned_end_date class-attribute instance-attribute

planned_end_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedEndDate'})

Date string of planned end date

planned_start_date class-attribute instance-attribute

planned_start_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedStartDate'})

Date string of planned start date

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

Title of project

UpdateRequest dataclass

UpdateRequest(*, assignee_id: Optional[str] = None, content_refs: Optional[List[ContentRef | Mapping[str, Any]]] = None, custom_properties: Optional[List[CustomPropertyValuesInput | Mapping[str, Any]]] = None, form_ref: Optional[Any] = None, note: Optional[str] = None, planned_duration: Optional[int] = None, planned_end_date: Optional[str] = None, planned_start_date: Optional[str] = None, priority: Optional[str] = None, project_id: Optional[str] = None, step_id: Optional[int] = None, title: Optional[str] = None)

Definition: UpdateRequest

Attributes

assignee_id class-attribute instance-attribute

assignee_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'assigneeId'})

User ID of the assignee

content_refs class-attribute instance-attribute

content_refs: Optional[List[ContentRef | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'contentRefs'})

List of content references (WorkSpace and DocCenter content)

custom_properties class-attribute instance-attribute

custom_properties: Optional[List[CustomPropertyValuesInput | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'customProperties'})

List of custom properties

form_ref class-attribute instance-attribute

form_ref: Optional[Any] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'formRef'})

Form reference object

note class-attribute instance-attribute

note: Optional[str] = dataclass_field(default=None, kw_only=True)

Note used for notifications on status changes

planned_duration class-attribute instance-attribute

planned_duration: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedDuration'})

Planned duration in days

planned_end_date class-attribute instance-attribute

planned_end_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedEndDate'})

Date string of planned end date (due date)

planned_start_date class-attribute instance-attribute

planned_start_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedStartDate'})

Date string of planned start date

priority class-attribute instance-attribute

priority: Optional[str] = dataclass_field(default=None, kw_only=True)

Priority value

project_id class-attribute instance-attribute

project_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'projectId'})

Project ID of the project the request belongs to

step_id class-attribute instance-attribute

step_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'stepId'})

Step ID indicating status

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

Title of the request

UpdateTask dataclass

UpdateTask(*, assignee_id: Optional[str] = None, custom_properties: Optional[List[CustomPropertyValuesInput | Mapping[str, Any]]] = None, description: Optional[str] = None, parent_id: Optional[str] = None, planned_duration: Optional[int] = None, planned_end_date: Optional[str] = None, planned_start_date: Optional[str] = None, priority: Optional[str] = None, project_id: Optional[str] = None, step_id: Optional[int] = None, title: Optional[str] = None)

Definition: UpdateTask

Attributes

assignee_id class-attribute instance-attribute

assignee_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'assigneeId'})

User ID of the assignee

custom_properties class-attribute instance-attribute

custom_properties: Optional[List[CustomPropertyValuesInput | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'customProperties'})

List of custom properties

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

Description of task

parent_id class-attribute instance-attribute

parent_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'parentId'})

Task ID of parent task

planned_duration class-attribute instance-attribute

planned_duration: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedDuration'})

Planned duration in days

planned_end_date class-attribute instance-attribute

planned_end_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedEndDate'})

Date string of planned end date

planned_start_date class-attribute instance-attribute

planned_start_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'plannedStartDate'})

Date string of planned start date

priority class-attribute instance-attribute

priority: Optional[str] = dataclass_field(default=None, kw_only=True)

Priority value

project_id class-attribute instance-attribute

project_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'projectId'})

Project ID that the task belongs to

step_id class-attribute instance-attribute

step_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'stepId'})

Step ID indicating the task status

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

Title of task

ValueSchemaPropertyDefinition dataclass

ValueSchemaPropertyDefinition(*, max: Optional[str] = None, min: Optional[str] = None)

Definition: ValueSchemaPropertyDefinition

SeismicplannerClient

SeismicplannerClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

Bases: ConnectorClientBase

Typed client for seismicplanner connector.

Initialize a SeismicplannerClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

list_comments

list_comments(space_id: str, node_id: str, *, creator_ids: Optional[List[str]] = None, cursor: Optional[str] = None, limit: Optional[int] = None, sort: Optional[List[str]] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get comments

Get all comments for a given project, task, or request. Requires node (project, task, or request) ID.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetComments.

Parameters:

Name	Type	Description	Default
space_id	str	Space ID.	required
node_id	str	Node ID.	required
creator_ids	Optional[List[str]]	List of user IDs to query by creator.	None
cursor	Optional[str]	Cursor used for pagination.	None
limit	Optional[int]	Number to limit records.	None
sort	Optional[List[str]]	Sort by query.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_comment async

create_comment(input: CreateCommentModel | Mapping[str, Any], space_id: str, node_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create comment

Create a comment on a given project, task, or request. Requires node (project, task, or request) ID.

Swagger operation ID: CreateComment.

Parameters:

Name	Type	Description	Default
input	CreateCommentModel | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
space_id	str	Space ID.	required
node_id	str	Node ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_comment async

get_comment(space_id: str, node_id: str, comment_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get comment

Get a single comment. Requires node (project, task, or request) and comment ID.

Swagger operation ID: GetComment.

Parameters:

Name	Type	Description	Default
space_id	str	Space ID.	required
node_id	str	Node ID.	required
comment_id	str	Comment ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_comment async

delete_comment(space_id: str, node_id: str, comment_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete comment

Delete a comment. Requires node (project, task, or request) and comment ID.

Swagger operation ID: DeleteComment.

Parameters:

Name	Type	Description	Default
space_id	str	Space ID.	required
node_id	str	Node ID.	required
comment_id	str	Comment ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

update_comment async

update_comment(input: UpdateCommentModel | Mapping[str, Any], space_id: str, node_id: str, comment_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update comment

Update an existing comment. Requires node (project, task, or request) and comment ID.

Swagger operation ID: UpdateComment.

Parameters:

Name	Type	Description	Default
input	UpdateCommentModel | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
space_id	str	Space ID.	required
node_id	str	Node ID.	required
comment_id	str	Comment ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_projects

list_projects(space_id: str, *, planned_end_date_from: Optional[str] = None, planned_end_date_to: Optional[str] = None, planned_start_date_from: Optional[str] = None, planned_start_date_to: Optional[str] = None, ids: Optional[List[str]] = None, title: Optional[str] = None, manager_ids: Optional[List[str]] = None, creator_ids: Optional[List[str]] = None, associated_node_ids: Optional[List[str]] = None, cursor: Optional[str] = None, limit: Optional[int] = None, sort: Optional[List[str]] = None, custom_properties: Optional[str] = None, follower_ids: Optional[List[str]] = None, include_associations: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get projects

Get a list of projects with their attributes and associations.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetProjects.

Parameters:

Name	Type	Description	Default
space_id	str	Space ID.	required
planned_end_date_from	Optional[str]	Filter from a planned end date.	None
planned_end_date_to	Optional[str]	Filter to a planned end date.	None
planned_start_date_from	Optional[str]	Filter from a planned start date.	None
planned_start_date_to	Optional[str]	Filter to a planned start date.	None
ids	Optional[List[str]]	List of project IDs to query by.	None
title	Optional[str]	Project title to query by.	None
manager_ids	Optional[List[str]]	List of user IDs to query by manager.	None
creator_ids	Optional[List[str]]	List of user IDs to query by creator.	None
associated_node_ids	Optional[List[str]]	List of association IDs to query by.	None
cursor	Optional[str]	Cursor used for pagination.	None
limit	Optional[int]	Number to limit records returned.	None
sort	Optional[List[str]]	Sort query.	None
custom_properties	Optional[str]	List of custom properties to query by.	None
follower_ids	Optional[List[str]]	List of user IDs to query by follower.	None
include_associations	Optional[bool]	Indicator to allow for inclusion of association data.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_projects async

delete_projects(space_id: str, ids: List[str], *, delete_tasks: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Delete projects

Delete one or more projects.

Swagger operation ID: DeleteProjects.

Parameters:

Name	Type	Description	Default
space_id	str	Space ID.	required
ids	List[str]	List of project IDs.	required
delete_tasks	Optional[bool]	Also delete associated tasks.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_project async

create_project(input: CreateProject | Mapping[str, Any], space_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create project

Create a project.

Swagger operation ID: CreateProject.

Parameters:

Name	Type	Description	Default
input	CreateProject | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
space_id	str	Space ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_project async

get_project(space_id: str, project_id: str, *, associated_nodes_depth: Optional[int] = None, include_works: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get project

Get a single project by ID. Return tasks if desired.

Swagger operation ID: GetProject.

Parameters:

Name	Type	Description	Default
space_id	str	Space ID.	required
project_id	str	Project ID.	required
associated_nodes_depth	Optional[int]	Number to indicate depth of associated node data returned.	None
include_works	Optional[bool]	Indicator to include associated tasks data.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_project async

delete_project(space_id: str, project_id: str, *, delete_tasks: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Delete project

Delete a project.

Swagger operation ID: DeleteProject.

Parameters:

Name	Type	Description	Default
space_id	str	Space ID.	required
project_id	str	Project ID.	required
delete_tasks	Optional[bool]	Also delete associated tasks.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

update_project async

update_project(input: UpdateProject | Mapping[str, Any], space_id: str, project_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update a project

Update and return a project.

Swagger operation ID: UpdateProject.

Parameters:

Name	Type	Description	Default
input	UpdateProject | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
space_id	str	Space ID.	required
project_id	str	Project ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_requests

list_requests(space_id: str, *, planned_end_date_from: Optional[str] = None, planned_end_date_to: Optional[str] = None, planned_start_date_from: Optional[str] = None, planned_start_date_to: Optional[str] = None, created_at_from: Optional[str] = None, created_at_to: Optional[str] = None, updated_at_from: Optional[str] = None, updated_at_to: Optional[str] = None, ids: Optional[List[str]] = None, title: Optional[str] = None, assignee_ids: Optional[List[str]] = None, priorities: Optional[List[str]] = None, keywords: Optional[str] = None, assigner_ids: Optional[List[str]] = None, creator_ids: Optional[List[str]] = None, step_ids: Optional[List[int]] = None, status_schema_id: Optional[str] = None, cursor: Optional[str] = None, limit: Optional[int] = None, sort: Optional[List[str]] = None, project_id: Optional[str] = None, has_project: Optional[bool] = None, custom_properties: Optional[str] = None, follower_ids: Optional[List[str]] = None, associated_node_ids: Optional[List[str]] = None, content_refs: Optional[List[str]] = None, include_request_form_custom_properties: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get requests

Get a list of requests.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetRequests.

Parameters:

Name	Type	Description	Default
space_id	str	Space ID.	required
planned_end_date_from	Optional[str]	filter by request due date (inclusive).	None
planned_end_date_to	Optional[str]	filter by request due date (exclusive).	None
planned_start_date_from	Optional[str]	filter by request start date (inclusive).	None
planned_start_date_to	Optional[str]	filter by request start date (exclusive).	None
created_at_from	Optional[str]	filter by request created date (inclusive).	None
created_at_to	Optional[str]	filter by request created date (exclusive).	None
updated_at_from	Optional[str]	filter by request updated date (inclusive).	None
updated_at_to	Optional[str]	filter by request updated date (exclusive).	None
ids	Optional[List[str]]	A list of request IDs.	None
title	Optional[str]	Keyword values to search for on request titles.	None
assignee_ids	Optional[List[str]]	A list of assignees' user IDs to filter by.	None
priorities	Optional[List[str]]	A list of priority values, Available values : critical, high, medium, low.	None
keywords	Optional[str]	Keyword values to search.	None
assigner_ids	Optional[List[str]]	A list of assigner' user Ids to filter by.	None
creator_ids	Optional[List[str]]	A list of creators' user IDs to filter by.	None
step_ids	Optional[List[int]]	A list of step IDs to filter by.	None
status_schema_id	Optional[str]	Status schema ID to filter by.	None
cursor	Optional[str]	A token used to guide the next page window.	None
limit	Optional[int]	Number of items to return per page, default: 50.	None
sort	Optional[List[str]]	Sort by requests.	None
project_id	Optional[str]	The project ID a request is associated to.	None
has_project	Optional[bool]	Filter by if requests are associated with a project.	None
custom_properties	Optional[str]	Filter by custom properties.	None
follower_ids	Optional[List[str]]	A list of followers' user id.	None
associated_node_ids	Optional[List[str]]	A list of Associated node IDs to filter by.	None
content_refs	Optional[List[str]]	List of content reference objects.	None
include_request_form_custom_properties	Optional[bool]	whether to include request form custom properties, default false.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_requests async

delete_requests(input: DeleteRequest | Mapping[str, Any], space_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Delete requests

Bulk delete requests.

Swagger operation ID: DeleteRequests.

Parameters:

Name	Type	Description	Default
input	DeleteRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
space_id	str	Space ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_request async

create_request(input: CreateRequest | Mapping[str, Any], space_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create request

Create a request.

Swagger operation ID: CreateRequest.

Parameters:

Name	Type	Description	Default
input	CreateRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
space_id	str	Space ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_request async

get_request(space_id: str, request_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get request

Get a single request.

Swagger operation ID: GetRequest.

Parameters:

Name	Type	Description	Default
space_id	str	Space ID.	required
request_id	str	Request ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_request async

delete_request(space_id: str, request_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete request

Delete a request.

Swagger operation ID: DeleteRequest.

Parameters:

Name	Type	Description	Default
space_id	str	Space ID.	required
request_id	str	Request ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

update_request async

update_request(input: UpdateRequest | Mapping[str, Any], space_id: str, request_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update request

Update a request.

Swagger operation ID: UpdateRequest.

Parameters:

Name	Type	Description	Default
input	UpdateRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
space_id	str	Space ID.	required
request_id	str	Request ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_status_schemas

list_status_schemas(space_id: str, *, is_default: Optional[bool] = None, type_: Optional[str] = None, ids: Optional[List[str]] = None, creator_ids: Optional[List[str]] = None, cursor: Optional[str] = None, limit: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get status schemas

Get a list of task/request status schemas. These schemas hold the data for set statuses for specific work. Example: (Not started, In progress, Complete)

Returns a single-page Azure Core async collection.

Swagger operation ID: GetStatusSchemas.

Parameters:

Name	Type	Description	Default
space_id	str	Space ID.	required
is_default	Optional[bool]	Get default status schema.	None
type_	Optional[str]	Query by node type.	None
ids	Optional[List[str]]	List of status schemas IDs.	None
creator_ids	Optional[List[str]]	List of user IDs to query by creator.	None
cursor	Optional[str]	Cursor used for pagination.	None
limit	Optional[int]	Number to limit returned records.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_status_schema async

get_status_schema(space_id: str, status_schema_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get status schema

Get a single status schema by ID. These schemas hold the data for set statuses for specific work. Example: (Not started, In progress, Complete)

Swagger operation ID: GetStatusSchema.

Parameters:

Name	Type	Description	Default
space_id	str	Space ID.	required
status_schema_id	str	Status schema ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_tasks

list_tasks(space_id: str, *, planned_end_date_from: Optional[str] = None, planned_end_date_to: Optional[str] = None, planned_start_date_from: Optional[str] = None, planned_start_date_to: Optional[str] = None, created_at_from: Optional[str] = None, created_at_to: Optional[str] = None, updated_at_from: Optional[str] = None, updated_at_to: Optional[str] = None, ids: Optional[List[str]] = None, title: Optional[str] = None, description: Optional[str] = None, assignee_ids: Optional[List[str]] = None, priorities: Optional[List[str]] = None, keywords: Optional[str] = None, assigner_ids: Optional[List[str]] = None, step_ids: Optional[List[int]] = None, status_schema_id: Optional[str] = None, cursor: Optional[str] = None, limit: Optional[int] = None, sort: Optional[List[str]] = None, recursive: Optional[bool] = None, project_id: Optional[str] = None, has_project: Optional[bool] = None, custom_properties: Optional[str] = None, follower_ids: Optional[List[str]] = None, associated_node_ids: Optional[List[str]] = None, creator_ids: Optional[List[str]] = None, include_associations: Optional[bool] = None, parent_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get tasks

Get a list of tasks.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetTasks.

Parameters:

Name	Type	Description	Default
space_id	str	Space ID.	required
planned_end_date_from	Optional[str]	Filter by task due date (inclusive).	None
planned_end_date_to	Optional[str]	Filter by task due date (exclusive).	None
planned_start_date_from	Optional[str]	Filter by task start date (inclusive).	None
planned_start_date_to	Optional[str]	Filter by task start date (exclusive).	None
created_at_from	Optional[str]	Filter by task created date (inclusive).	None
created_at_to	Optional[str]	Filter by task created date (exclusive).	None
updated_at_from	Optional[str]	Filter by task updated date (inclusive).	None
updated_at_to	Optional[str]	Filter by task updated date (exclusive).	None
ids	Optional[List[str]]	Filter by a list of task IDs.	None
title	Optional[str]	Filter by task title.	None
description	Optional[str]	Filter by task description.	None
assignee_ids	Optional[List[str]]	List of user IDs to filter by assignee.	None
priorities	Optional[List[str]]	Filter by list of priorities.	None
keywords	Optional[str]	Filter by keywords.	None
assigner_ids	Optional[List[str]]	List of user IDs to filter by user that assigned the task.	None
step_ids	Optional[List[int]]	Filter by status value IDs.	None
status_schema_id	Optional[str]	Filter by status schema IDs.	None
cursor	Optional[str]	Cursor used for pagination.	None
limit	Optional[int]	Number to limit returned records.	None
sort	Optional[List[str]]	Sort by query.	None
recursive	Optional[bool]	Include subtasks within the returned list.	None
project_id	Optional[str]	Filter by project ID.	None
has_project	Optional[bool]	Filter by tasks that are associated with a project.	None
custom_properties	Optional[str]	Filter by custom property values.	None
follower_ids	Optional[List[str]]	List of user IDs to filter by followers.	None
associated_node_ids	Optional[List[str]]	List of association IDs to filter by.	None
creator_ids	Optional[List[str]]	List of user IDs to filter by creator.	None
include_associations	Optional[bool]	Include association data in the response.	None
parent_id	Optional[str]	List of task IDs to filter by.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_task async

create_task(input: CreateTask | Mapping[str, Any], space_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create task

Create a task.

Swagger operation ID: CreateTask.

Parameters:

Name	Type	Description	Default
input	CreateTask | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
space_id	str	Space ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_task async

get_task(space_id: str, task_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get task

Get a single task by ID.

Swagger operation ID: GetTask.

Parameters:

Name	Type	Description	Default
space_id	str	Space ID.	required
task_id	str	Task ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_task async

delete_task(space_id: str, task_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Delete task

Delete a task.

Swagger operation ID: DeleteTask.

Parameters:

Name	Type	Description	Default
space_id	str	Space ID.	required
task_id	str	Task ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

update_task async

update_task(input: UpdateTask | Mapping[str, Any], space_id: str, task_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update task

Update an existing task.

Swagger operation ID: UpdateTask.

Parameters:

Name	Type	Description	Default
input	UpdateTask | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
space_id	str	Space ID.	required
task_id	str	Task ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.