Skip to content

SeismicplannerClient

Classes

CommentQueryResponse dataclass 

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

Response for Get comments

Attributes

count class-attribute instance-attribute 
count: Optional[int] = None

Number of records returned

cursor class-attribute instance-attribute 
cursor: Optional[str] = None

Cursor used for pagination

items class-attribute instance-attribute 
items: Optional[List[Comment]] = None

List of items in the response

limit class-attribute instance-attribute 
limit: Optional[int] = None

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] = field(default=None, metadata={'wire_name': 'createdAt'})

Date string of date created

creator_id class-attribute instance-attribute 
creator_id: Optional[str] = field(default=None, metadata={'wire_name': 'creatorId'})

User ID of the creator

id class-attribute instance-attribute 
id: Optional[str] = None

Comment ID

is_resolved class-attribute instance-attribute 
is_resolved: Optional[bool] = field(default=None, metadata={'wire_name': 'isResolved'})

True/false on whether the comment is resolved

node_id class-attribute instance-attribute 
node_id: Optional[str] = field(default=None, metadata={'wire_name': 'nodeId'})

Node ID

node_type class-attribute instance-attribute 
node_type: Optional[str] = field(default=None, metadata={'wire_name': 'nodeType'})

Node type of the comment

page_index class-attribute instance-attribute 
page_index: Optional[str] = field(default=None, metadata={'wire_name': 'pageIndex'})

Number page index

parent_id class-attribute instance-attribute 
parent_id: Optional[str] = field(default=None, metadata={'wire_name': 'parentId'})

Parent comment ID

reply_count class-attribute instance-attribute 
reply_count: Optional[int] = field(default=None, metadata={'wire_name': 'replyCount'})

Number of replies

space_id class-attribute instance-attribute 
space_id: Optional[str] = field(default=None, metadata={'wire_name': 'spaceId'})

Space ID

updated_at class-attribute instance-attribute 
updated_at: Optional[str] = field(default=None, metadata={'wire_name': 'updatedAt'})

Date string of updated date

PlannerProjectQueryResponse dataclass 

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

Response for Get projects

Attributes

count class-attribute instance-attribute 
count: Optional[int] = None

Number of records returned

cursor class-attribute instance-attribute 
cursor: Optional[str] = None

Cursor used for pagination

items class-attribute instance-attribute 
items: Optional[List[PlannerProject]] = None

List of project items in the response

limit class-attribute instance-attribute 
limit: Optional[int] = None

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]] = field(default=None, 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]] = None, associations: Optional[List[Association]] = None, copy_from: Optional[str] = None, created_at: Optional[str] = None, creator_id: Optional[str] = None, custom_properties: Optional[List[CustomPropertyValues]] = None, description: Optional[str] = None, followers: Optional[List[Follower]] = 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]] = None)

Response for Create project

Attributes

actual_duration class-attribute instance-attribute 
actual_duration: Optional[int] = field(default=None, metadata={'wire_name': 'actualDuration'})

Calculated actual duration in days

actual_end_date class-attribute instance-attribute 
actual_end_date: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'actualStartDate'})

Calculated start date from when the project actually started

associated_nodes class-attribute instance-attribute 
associated_nodes: Optional[List[ProjectAssociatedNodes]] = field(default=None, metadata={'wire_name': 'associatedNodes'})

List of association data

associations class-attribute instance-attribute 
associations: Optional[List[Association]] = None

List of associations (Library content)

copy_from class-attribute instance-attribute 
copy_from: Optional[str] = field(default=None, metadata={'wire_name': 'copyFrom'})

Project ID the project is copied from

created_at class-attribute instance-attribute 
created_at: Optional[str] = field(default=None, metadata={'wire_name': 'createdAt'})

Date string of created date

creator_id class-attribute instance-attribute 
creator_id: Optional[str] = field(default=None, metadata={'wire_name': 'creatorId'})

User ID of creator

custom_properties class-attribute instance-attribute 
custom_properties: Optional[List[CustomPropertyValues]] = field(default=None, metadata={'wire_name': 'customProperties'})

List of custom properties

description class-attribute instance-attribute 
description: Optional[str] = None

Description of project

followers class-attribute instance-attribute 
followers: Optional[List[Follower]] = None

List of followers

is_active class-attribute instance-attribute 
is_active: Optional[bool] = field(default=None, metadata={'wire_name': 'isActive'})

Indicator on if a project is active or not

is_template class-attribute instance-attribute 
is_template: Optional[bool] = field(default=None, metadata={'wire_name': 'isTemplate'})

Indicator on if the project is a template or not

manager_id class-attribute instance-attribute 
manager_id: Optional[str] = field(default=None, metadata={'wire_name': 'managerId'})

User ID of project manager

max_rank class-attribute instance-attribute 
max_rank: Optional[str] = field(default=None, metadata={'wire_name': 'maxRank'})

Maximum rank number

min_rank class-attribute instance-attribute 
min_rank: Optional[str] = field(default=None, metadata={'wire_name': 'minRank'})

Minimum rank number

planned_duration class-attribute instance-attribute 
planned_duration: Optional[int] = field(default=None, metadata={'wire_name': 'plannedDuration'})

Planned duration in days

planned_end_date class-attribute instance-attribute 
planned_end_date: Optional[str] = field(default=None, metadata={'wire_name': 'plannedEndDate'})

Date string of planned end date

planned_start_date class-attribute instance-attribute 
planned_start_date: Optional[str] = field(default=None, metadata={'wire_name': 'plannedStartDate'})

Date string of planned start date

template_id class-attribute instance-attribute 
template_id: Optional[str] = field(default=None, metadata={'wire_name': 'templateId'})

Template ID the the project was created from

title class-attribute instance-attribute 
title: Optional[str] = None

Title of project

updated_at class-attribute instance-attribute 
updated_at: Optional[str] = field(default=None, metadata={'wire_name': 'updatedAt'})

Date project was last updated

works class-attribute instance-attribute 
works: Optional[List[PlannerTask]] = None

List of tasks and requests

PlannerRequestQueryResponse dataclass 

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

Response for Get requests

Attributes

count class-attribute instance-attribute 
count: Optional[int] = None

Number of records returned

cursor class-attribute instance-attribute 
cursor: Optional[str] = None

Cursor used for pagination

items class-attribute instance-attribute 
items: Optional[List[PlannerRequest]] = None

List of request objects in the response

limit class-attribute instance-attribute 
limit: Optional[int] = None

Number to limit records

PlannerRequest dataclass 

PlannerRequest(assignee_id: Optional[str] = None, assigner_id: Optional[str] = None, associations: Optional[List[Association]] = None, content_refs: Optional[List[ContentRef]] = None, created_at: Optional[str] = None, creator_id: Optional[str] = None, custom_properties: Optional[List[CustomPropertyValues]] = None, followers: Optional[List[Follower]] = 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] = 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] = field(default=None, metadata={'wire_name': 'assigneeId'})

User ID of the assignee

assigner_id class-attribute instance-attribute 
assigner_id: Optional[str] = field(default=None, metadata={'wire_name': 'assignerId'})

User ID of the assigner

associations class-attribute instance-attribute 
associations: Optional[List[Association]] = None

List of associations (Library content)

content_refs class-attribute instance-attribute 
content_refs: Optional[List[ContentRef]] = field(default=None, metadata={'wire_name': 'contentRefs'})

List of content references (WorkSpace and DocCenter content)

created_at class-attribute instance-attribute 
created_at: Optional[str] = field(default=None, metadata={'wire_name': 'createdAt'})

Date string for created date

creator_id class-attribute instance-attribute 
creator_id: Optional[str] = field(default=None, metadata={'wire_name': 'creatorId'})

User ID of the creator

custom_properties class-attribute instance-attribute 
custom_properties: Optional[List[CustomPropertyValues]] = field(default=None, metadata={'wire_name': 'customProperties'})

List of custom properties

followers class-attribute instance-attribute 
followers: Optional[List[Follower]] = None

List of followers

form_ref class-attribute instance-attribute 
form_ref: Optional[Any] = field(default=None, metadata={'wire_name': 'formRef'})

Form reference object

note class-attribute instance-attribute 
note: Optional[str] = None

Note for notifications on status changes

planned_duration class-attribute instance-attribute 
planned_duration: Optional[int] = field(default=None, metadata={'wire_name': 'plannedDuration'})

Planned duration in days

planned_end_date class-attribute instance-attribute 
planned_end_date: Optional[str] = field(default=None, metadata={'wire_name': 'plannedEndDate'})

Date string of planned end date

planned_start_date class-attribute instance-attribute 
planned_start_date: Optional[str] = field(default=None, metadata={'wire_name': 'plannedStartDate'})

Date string of planned start date

priority class-attribute instance-attribute 
priority: Optional[str] = None

Priority value

project_id class-attribute instance-attribute 
project_id: Optional[str] = field(default=None, metadata={'wire_name': 'projectId'})

Project ID of the project the request is associated with

rank class-attribute instance-attribute 
rank: Optional[str] = None

Rank of request in request list

step_id class-attribute instance-attribute 
step_id: Optional[int] = field(default=None, metadata={'wire_name': 'stepId'})

Step ID indicating the status value

title class-attribute instance-attribute 
title: Optional[str] = None

Title of the request

updated_at class-attribute instance-attribute 
updated_at: Optional[str] = field(default=None, 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]] = None, limit: Optional[int] = None, meta: Optional[Meta] = None)

Response for Get status schemas

Attributes

count class-attribute instance-attribute 
count: Optional[int] = None

Number of records returned

cursor class-attribute instance-attribute 
cursor: Optional[str] = None

Cursor used for pagination

items class-attribute instance-attribute 
items: Optional[List[StatusSchema]] = None

List of status schema objects in the response

limit class-attribute instance-attribute 
limit: Optional[int] = None

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] = field(default=None, metadata={'wire_name': 'createdAt'})

Date string of created date

creator_id class-attribute instance-attribute 
creator_id: Optional[str] = field(default=None, metadata={'wire_name': 'creatorId'})

User ID of creator

is_default class-attribute instance-attribute 
is_default: Optional[bool] = field(default=None, metadata={'wire_name': 'isDefault'})

Indicator on if the status schema is the default schema

name class-attribute instance-attribute 
name: Optional[str] = None

Name of status schema

steps class-attribute instance-attribute 
steps: Optional[List[str]] = None

List of steps and their values

transitions class-attribute instance-attribute 
transitions: Optional[List[List[int]]] = None

List of transition rules

type_ class-attribute instance-attribute 
type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Node type the status schema can be used for

updated_at class-attribute instance-attribute 
updated_at: Optional[str] = field(default=None, 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]] = None, limit: Optional[int] = None, meta: Optional[Meta] = None)

Response for Get tasks

Attributes

count class-attribute instance-attribute 
count: Optional[int] = None

Number of records returned

cursor class-attribute instance-attribute 
cursor: Optional[str] = None

Cursor used for pagination

items class-attribute instance-attribute 
items: Optional[List[PlannerTask]] = None

List of task objects in the response

limit class-attribute instance-attribute 
limit: Optional[int] = None

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]] = None, copy_from: Optional[str] = None, created_at: Optional[str] = None, creator_id: Optional[str] = None, custom_properties: Optional[List[CustomPropertyValues]] = None, description: Optional[str] = None, followers: Optional[List[Follower]] = 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]] = 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] = field(default=None, metadata={'wire_name': 'actualDuration'})

Calculated actual duration in days

actual_end_date class-attribute instance-attribute 
actual_end_date: Optional[str] = field(default=None, metadata={'wire_name': 'actualEndDate'})

Date when work on the task was completed

actual_start_date class-attribute instance-attribute 
actual_start_date: Optional[str] = field(default=None, metadata={'wire_name': 'actualStartDate'})

Date when work on the task started

assignee_id class-attribute instance-attribute 
assignee_id: Optional[str] = field(default=None, metadata={'wire_name': 'assigneeId'})

User ID of assignee

assigner_id class-attribute instance-attribute 
assigner_id: Optional[str] = field(default=None, metadata={'wire_name': 'assignerId'})

User ID of the last user to add an assignee

associations class-attribute instance-attribute 
associations: Optional[List[Association]] = None

List of associations on a task

copy_from class-attribute instance-attribute 
copy_from: Optional[str] = field(default=None, metadata={'wire_name': 'copyFrom'})

Task ID that task was copied from

created_at class-attribute instance-attribute 
created_at: Optional[str] = field(default=None, metadata={'wire_name': 'createdAt'})

Date the task was created

creator_id class-attribute instance-attribute 
creator_id: Optional[str] = field(default=None, metadata={'wire_name': 'creatorId'})

User ID of creator

custom_properties class-attribute instance-attribute 
custom_properties: Optional[List[CustomPropertyValues]] = field(default=None, metadata={'wire_name': 'customProperties'})

List of custom properties on a task

description class-attribute instance-attribute 
description: Optional[str] = None

Description of task

followers class-attribute instance-attribute 
followers: Optional[List[Follower]] = None

List of followers on a task

is_template class-attribute instance-attribute 
is_template: Optional[bool] = field(default=None, metadata={'wire_name': 'isTemplate'})

Indicates if a task is part of a template

max_rank class-attribute instance-attribute 
max_rank: Optional[str] = field(default=None, metadata={'wire_name': 'maxRank'})

Maximum rank

min_rank class-attribute instance-attribute 
min_rank: Optional[str] = field(default=None, metadata={'wire_name': 'minRank'})

Minimum rank

parent_id class-attribute instance-attribute 
parent_id: Optional[str] = field(default=None, metadata={'wire_name': 'parentId'})

Task ID of parent if task is a subtask

planned_duration class-attribute instance-attribute 
planned_duration: Optional[int] = field(default=None, metadata={'wire_name': 'plannedDuration'})

Planned duration in days

planned_end_date class-attribute instance-attribute 
planned_end_date: Optional[str] = field(default=None, metadata={'wire_name': 'plannedEndDate'})

Date string of planned end date (due date)

planned_start_date class-attribute instance-attribute 
planned_start_date: Optional[str] = field(default=None, metadata={'wire_name': 'plannedStartDate'})

Date string of planned start date

priority class-attribute instance-attribute 
priority: Optional[str] = None

Priority value

project_id class-attribute instance-attribute 
project_id: Optional[str] = field(default=None, metadata={'wire_name': 'projectId'})

Project ID the task belongs to

rank class-attribute instance-attribute 
rank: Optional[str] = None

Rank of task in a task list

step_id class-attribute instance-attribute 
step_id: Optional[int] = field(default=None, metadata={'wire_name': 'stepId'})

Id of step in status schema

sub_task_ids class-attribute instance-attribute 
sub_task_ids: Optional[List[str]] = field(default=None, metadata={'wire_name': 'subTaskIds'})

List of subtask IDs

sub_tasks class-attribute instance-attribute 
sub_tasks: Optional[List[PlannerSubTask]] = field(default=None, metadata={'wire_name': 'subTasks'})

List of subtasks on the task

template_id class-attribute instance-attribute 
template_id: Optional[str] = field(default=None, metadata={'wire_name': 'templateId'})

Template ID of the template the task belongs to

title class-attribute instance-attribute 
title: Optional[str] = None

Title of task

type_ class-attribute instance-attribute 
type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type of task

updated_at class-attribute instance-attribute 
updated_at: Optional[str] = field(default=None, 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] = None

Description of association

name class-attribute instance-attribute 
name: Optional[str] = None

Name of association

node_guid class-attribute instance-attribute 
node_guid: Optional[str] = field(default=None, metadata={'wire_name': 'nodeGuid'})

Longer GUID format

node_id class-attribute instance-attribute 
node_id: Optional[str] = field(default=None, metadata={'wire_name': 'nodeId'})

Node ID

node_type class-attribute instance-attribute 
node_type: Optional[str] = field(default=None, metadata={'wire_name': 'nodeType'})

Node type of the association

space_guid class-attribute instance-attribute 
space_guid: Optional[str] = field(default=None, metadata={'wire_name': 'spaceGuid'})

Longer GUID format

space_id class-attribute instance-attribute 
space_id: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'nodeId'})

Node ID

node_type class-attribute instance-attribute 
node_type: Optional[str] = field(default=None, metadata={'wire_name': 'nodeType'})

Node type of the association

space_id class-attribute instance-attribute 
space_id: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'contentId'})

Content ID

doc_center_full_path class-attribute instance-attribute 
doc_center_full_path: Optional[str] = field(default=None, metadata={'wire_name': 'docCenterFullPath'})

Full location path of where content exists in DocCenter

major_version class-attribute instance-attribute 
major_version: Optional[int] = field(default=None, metadata={'wire_name': 'majorVersion'})

Number of major version

minor_version class-attribute instance-attribute 
minor_version: Optional[int] = field(default=None, metadata={'wire_name': 'minorVersion'})

Number of minor version

modified_date class-attribute instance-attribute 
modified_date: Optional[str] = field(default=None, metadata={'wire_name': 'modifiedDate'})

Date the content reference was last updated

order_no class-attribute instance-attribute 
order_no: Optional[int] = field(default=None, metadata={'wire_name': 'orderNo'})

Number to indicate order

profile_id class-attribute instance-attribute 
profile_id: Optional[str] = field(default=None, metadata={'wire_name': 'profileId'})

Profile ID

profile_version_id class-attribute instance-attribute 
profile_version_id: Optional[str] = field(default=None, metadata={'wire_name': 'profileVersionId'})

Version ID of profile

source class-attribute instance-attribute 
source: Optional[str] = None

Source of content

team_site_id class-attribute instance-attribute 
team_site_id: Optional[str] = field(default=None, metadata={'wire_name': 'teamSiteId'})

TeamSite ID

thumbnail_id class-attribute instance-attribute 
thumbnail_id: Optional[str] = field(default=None, metadata={'wire_name': 'thumbnailId'})

ID for image thumbnail

version_id class-attribute instance-attribute 
version_id: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'annotationType'})

Annotation type

comment_content class-attribute instance-attribute 
comment_content: Optional[str] = field(default=None, metadata={'wire_name': 'commentContent'})

Content of the comment

is_resolved class-attribute instance-attribute 
is_resolved: Optional[bool] = field(default=None, metadata={'wire_name': 'isResolved'})

True/false on whether the comment is resolved

CreateProject dataclass 

CreateProject(associations: Optional[List[AssociationReq]] = None, custom_properties: Optional[List[CustomPropertyValuesInput]] = 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]] = None

List of association objects

custom_properties class-attribute instance-attribute 
custom_properties: Optional[List[CustomPropertyValuesInput]] = field(default=None, metadata={'wire_name': 'customProperties'})

List of custom properties

description class-attribute instance-attribute 
description: Optional[str] = None

Title of description

manager_id class-attribute instance-attribute 
manager_id: Optional[str] = field(default=None, metadata={'wire_name': 'managerId'})

User ID of manager

planned_duration class-attribute instance-attribute 
planned_duration: Optional[int] = field(default=None, metadata={'wire_name': 'plannedDuration'})

Planned duration in days

planned_end_date class-attribute instance-attribute 
planned_end_date: Optional[str] = field(default=None, metadata={'wire_name': 'plannedEndDate'})

Date string of end date

planned_start_date class-attribute instance-attribute 
planned_start_date: Optional[str] = field(default=None, metadata={'wire_name': 'plannedStartDate'})

Date string of start date

title class-attribute instance-attribute 
title: Optional[str] = None

Title of project

CreateRequest dataclass 

CreateRequest(assignee_id: Optional[str] = None, associations: Optional[List[AssociationReq]] = None, content_refs: Optional[List[ContentRef]] = None, custom_properties: Optional[List[CustomPropertyValuesInput]] = 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] = field(default=None, metadata={'wire_name': 'assigneeId'})

User ID of assignee

associations class-attribute instance-attribute 
associations: Optional[List[AssociationReq]] = None

List of associations (Library content)

content_refs class-attribute instance-attribute 
content_refs: Optional[List[ContentRef]] = field(default=None, metadata={'wire_name': 'contentRefs'})

List of content references (DocCenter and Workspace associations)

custom_properties class-attribute instance-attribute 
custom_properties: Optional[List[CustomPropertyValuesInput]] = field(default=None, metadata={'wire_name': 'customProperties'})

List of custom properties

form_ref class-attribute instance-attribute 
form_ref: Optional[Any] = field(default=None, metadata={'wire_name': 'formRef'})

Form reference object

planned_duration class-attribute instance-attribute 
planned_duration: Optional[int] = field(default=None, metadata={'wire_name': 'plannedDuration'})

Planned duration in days

planned_end_date class-attribute instance-attribute 
planned_end_date: Optional[str] = field(default=None, metadata={'wire_name': 'plannedEndDate'})

Date string of end date

planned_start_date class-attribute instance-attribute 
planned_start_date: Optional[str] = field(default=None, metadata={'wire_name': 'plannedStartDate'})

Date string of start date

priority class-attribute instance-attribute 
priority: Optional[str] = None

Priority value

project_id class-attribute instance-attribute 
project_id: Optional[str] = field(default=None, metadata={'wire_name': 'projectId'})

ID of project the request belongs to

title class-attribute instance-attribute 
title: Optional[str] = None

Title of request

CreateTask dataclass 

CreateTask(assignee_id: Optional[str] = None, associations: Optional[List[AssociationReq]] = None, custom_properties: Optional[List[CustomPropertyValuesInput]] = 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] = field(default=None, metadata={'wire_name': 'assigneeId'})

User ID of assignee

associations class-attribute instance-attribute 
associations: Optional[List[AssociationReq]] = None

List of associations (Library content)

custom_properties class-attribute instance-attribute 
custom_properties: Optional[List[CustomPropertyValuesInput]] = field(default=None, metadata={'wire_name': 'customProperties'})

List of custom properties

description class-attribute instance-attribute 
description: Optional[str] = None

Description of task

parent_id class-attribute instance-attribute 
parent_id: Optional[str] = field(default=None, metadata={'wire_name': 'parentId'})

Task ID of parent

planned_duration class-attribute instance-attribute 
planned_duration: Optional[int] = field(default=None, metadata={'wire_name': 'plannedDuration'})

Planned duration in days

planned_end_date class-attribute instance-attribute 
planned_end_date: Optional[str] = field(default=None, metadata={'wire_name': 'plannedEndDate'})

Date string of end date

planned_start_date class-attribute instance-attribute 
planned_start_date: Optional[str] = field(default=None, metadata={'wire_name': 'plannedStartDate'})

Date string of start date

priority class-attribute instance-attribute 
priority: Optional[str] = None

Priority values

project_id class-attribute instance-attribute 
project_id: Optional[str] = field(default=None, metadata={'wire_name': 'projectId'})

ID of project the task is associated with

title class-attribute instance-attribute 
title: Optional[str] = None

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]] = None, scope_settings: Optional[List[ScopeSettingsItemDefinition]] = None, scopes: Optional[List[str]] = None, value_schema_name: Optional[str] = None, value_schema_property: Optional[ValueSchemaPropertyDefinition] = None, value_type: Optional[str] = None)

Definition: CustomProperty

Attributes

allow_multiple_values class-attribute instance-attribute 
allow_multiple_values: Optional[bool] = field(default=None, metadata={'wire_name': 'allowMultipleValues'})

Indicates if custom property allows for multiple values

created_by_id class-attribute instance-attribute 
created_by_id: Optional[str] = field(default=None, metadata={'wire_name': 'createdById'})

User ID of the creator

has_domain_of_values class-attribute instance-attribute 
has_domain_of_values: Optional[bool] = field(default=None, metadata={'wire_name': 'hasDomainOfValues'})

Indicates if custom property has possible values

hint class-attribute instance-attribute 
hint: Optional[str] = None

Value that describes the hint displayed under the custom property name

is_required class-attribute instance-attribute 
is_required: Optional[bool] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'lastModifiedById'})

User ID of the user that last updated the custom property

name class-attribute instance-attribute 
name: Optional[str] = None

Name of custom property

operation_setting class-attribute instance-attribute 
operation_setting: Optional[str] = field(default=None, metadata={'wire_name': 'operationSetting'})

Object that describes settings for different operations on a custom property

order class-attribute instance-attribute 
order: Optional[int] = None

Number indicating order within custom property list

possible_values class-attribute instance-attribute 
possible_values: Optional[List[PossibleValuesItem]] = field(default=None, 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]] = field(default=None, metadata={'wire_name': 'scopeSettings'})

Object that describes settings for different scopes on a custom property

scopes class-attribute instance-attribute 
scopes: Optional[List[str]] = None

List of scopes

value_schema_name class-attribute instance-attribute 
value_schema_name: Optional[str] = field(default=None, metadata={'wire_name': 'valueSchemaName'})

Name of custom property value schema

value_type class-attribute instance-attribute 
value_type: Optional[str] = field(default=None, 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] = None

Name of custom property

CustomPropertyValues dataclass 

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

Definition: CustomPropertyValues

Attributes

localizations class-attribute instance-attribute 
localizations: Optional[Dict[str, CustomPropertyDataDisplay]] = None

Localization object

multiple_value class-attribute instance-attribute 
multiple_value: Optional[bool] = field(default=None, metadata={'wire_name': 'multipleValue'})

Indicate if the custom property allows multiple values

name class-attribute instance-attribute 
name: Optional[str] = None

Name of custom property

values class-attribute instance-attribute 
values: Optional[List[CustomPropertyValuesValues]] = None

List of custom property values

CustomPropertyValuesInput dataclass 

CustomPropertyValuesInput(id: Optional[str] = None, values: Optional[List[CustomPropertyValuesValues]] = None)

Definition: CustomPropertyValuesInput

Attributes

values class-attribute instance-attribute 
values: Optional[List[CustomPropertyValuesValues]] = None

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] = None

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]] = None

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] = None

User/User group ID of follower

type_ class-attribute instance-attribute 
type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Either user or user group follower type

Meta dataclass 

Meta(count: Optional[int] = None, query: Optional[List[MetaQueryInfo]] = None)

Definition: Meta

Attributes

count class-attribute instance-attribute 
count: Optional[int] = None

Number of records returned

query class-attribute instance-attribute 
query: Optional[List[MetaQueryInfo]] = None

Query object

MetaQueryInfo dataclass 

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

Definition: MetaQueryInfo

Attributes

sort class-attribute instance-attribute 
sort: Optional[List[str]] = None

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]] = None, copy_from: Optional[str] = None, created_at: Optional[str] = None, creator_id: Optional[str] = None, custom_properties: Optional[List[CustomPropertyValues]] = None, description: Optional[str] = None, followers: Optional[List[Follower]] = 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] = field(default=None, metadata={'wire_name': 'actualDuration'})

Calculated actual duration in days

actual_end_date class-attribute instance-attribute 
actual_end_date: Optional[str] = field(default=None, metadata={'wire_name': 'actualEndDate'})

Date when work on the task was completed

actual_start_date class-attribute instance-attribute 
actual_start_date: Optional[str] = field(default=None, metadata={'wire_name': 'actualStartDate'})

Date when work on the task started

assignee_id class-attribute instance-attribute 
assignee_id: Optional[str] = field(default=None, metadata={'wire_name': 'assigneeId'})

User ID of assignee

assigner_id class-attribute instance-attribute 
assigner_id: Optional[str] = field(default=None, metadata={'wire_name': 'assignerId'})

User ID of the last user to add an assignee

associations class-attribute instance-attribute 
associations: Optional[List[Association]] = None

List of associations on a task

copy_from class-attribute instance-attribute 
copy_from: Optional[str] = field(default=None, metadata={'wire_name': 'copyFrom'})

Task ID that task was copied from

created_at class-attribute instance-attribute 
created_at: Optional[str] = field(default=None, metadata={'wire_name': 'createdAt'})

Date the task was created

creator_id class-attribute instance-attribute 
creator_id: Optional[str] = field(default=None, metadata={'wire_name': 'creatorId'})

User ID of creator

custom_properties class-attribute instance-attribute 
custom_properties: Optional[List[CustomPropertyValues]] = field(default=None, metadata={'wire_name': 'customProperties'})

List of custom properties on a task

description class-attribute instance-attribute 
description: Optional[str] = None

Description of task

followers class-attribute instance-attribute 
followers: Optional[List[Follower]] = None

List of followers on a task

is_template class-attribute instance-attribute 
is_template: Optional[bool] = field(default=None, metadata={'wire_name': 'isTemplate'})

Indicates if a task is part of a template

max_rank class-attribute instance-attribute 
max_rank: Optional[str] = field(default=None, metadata={'wire_name': 'maxRank'})

Maximum rank

min_rank class-attribute instance-attribute 
min_rank: Optional[str] = field(default=None, metadata={'wire_name': 'minRank'})

Minimum rank

parent_id class-attribute instance-attribute 
parent_id: Optional[str] = field(default=None, metadata={'wire_name': 'parentId'})

Task ID of parent if task is a subtask

planned_duration class-attribute instance-attribute 
planned_duration: Optional[int] = field(default=None, metadata={'wire_name': 'plannedDuration'})

Planned duration in days

planned_end_date class-attribute instance-attribute 
planned_end_date: Optional[str] = field(default=None, metadata={'wire_name': 'plannedEndDate'})

Date string of end date (due date)

planned_start_date class-attribute instance-attribute 
planned_start_date: Optional[str] = field(default=None, metadata={'wire_name': 'plannedStartDate'})

Date string of start date

priority class-attribute instance-attribute 
priority: Optional[str] = None

Priority value

project_id class-attribute instance-attribute 
project_id: Optional[str] = field(default=None, metadata={'wire_name': 'projectId'})

Project ID the task belongs to

rank class-attribute instance-attribute 
rank: Optional[str] = None

Rank of task in a task list

step_id class-attribute instance-attribute 
step_id: Optional[int] = field(default=None, metadata={'wire_name': 'stepId'})

Id of step in status schema

template_id class-attribute instance-attribute 
template_id: Optional[str] = field(default=None, metadata={'wire_name': 'templateId'})

Template ID of the template the task belongs to

title class-attribute instance-attribute 
title: Optional[str] = None

Title of task

type_ class-attribute instance-attribute 
type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type of task

updated_at class-attribute instance-attribute 
updated_at: Optional[str] = field(default=None, 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] = None

Number to indicate order

value class-attribute instance-attribute 
value: Optional[Any] = None

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] = field(default=None, metadata={'wire_name': 'nodeType'})

Node type of the association

RequestFormCustomProperties dataclass 

RequestFormCustomProperties(created_at: Optional[str] = None, custom_properties: Optional[List[CustomProperty]] = None)

Definition: RequestFormCustomProperties

Attributes

created_at class-attribute instance-attribute 
created_at: Optional[str] = field(default=None, metadata={'wire_name': 'createdAt'})

Date string of created date

custom_properties class-attribute instance-attribute 
custom_properties: Optional[List[CustomProperty]] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'isRequired'})

Indicator on whether a field is required or not

scope class-attribute instance-attribute 
scope: Optional[str] = None

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] = field(default=None, metadata={'wire_name': 'commentContent'})

Content of the comment

is_resolved class-attribute instance-attribute 
is_resolved: Optional[bool] = field(default=None, metadata={'wire_name': 'isResolved'})

True/false on whether the comment is resolved

UpdateProject dataclass 

UpdateProject(custom_properties: Optional[List[CustomPropertyValues]] = 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]] = field(default=None, metadata={'wire_name': 'customProperties'})

List of custom properties

description class-attribute instance-attribute 
description: Optional[str] = None

Description of project

is_active class-attribute instance-attribute 
is_active: Optional[bool] = field(default=None, metadata={'wire_name': 'isActive'})

Indicator on whether a project is active?

manager_id class-attribute instance-attribute 
manager_id: Optional[str] = field(default=None, metadata={'wire_name': 'managerId'})

User ID of project manager

max_rank class-attribute instance-attribute 
max_rank: Optional[str] = field(default=None, metadata={'wire_name': 'maxRank'})

Maximum rank number

min_rank class-attribute instance-attribute 
min_rank: Optional[str] = field(default=None, metadata={'wire_name': 'minRank'})

Minimum rank number

planned_duration class-attribute instance-attribute 
planned_duration: Optional[int] = field(default=None, metadata={'wire_name': 'plannedDuration'})

Planned duration in days

planned_end_date class-attribute instance-attribute 
planned_end_date: Optional[str] = field(default=None, metadata={'wire_name': 'plannedEndDate'})

Date string of planned end date

planned_start_date class-attribute instance-attribute 
planned_start_date: Optional[str] = field(default=None, metadata={'wire_name': 'plannedStartDate'})

Date string of planned start date

title class-attribute instance-attribute 
title: Optional[str] = None

Title of project

UpdateRequest dataclass 

UpdateRequest(assignee_id: Optional[str] = None, content_refs: Optional[List[ContentRef]] = None, custom_properties: Optional[List[CustomPropertyValuesInput]] = 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] = field(default=None, metadata={'wire_name': 'assigneeId'})

User ID of the assignee

content_refs class-attribute instance-attribute 
content_refs: Optional[List[ContentRef]] = field(default=None, metadata={'wire_name': 'contentRefs'})

List of content references (WorkSpace and DocCenter content)

custom_properties class-attribute instance-attribute 
custom_properties: Optional[List[CustomPropertyValuesInput]] = field(default=None, metadata={'wire_name': 'customProperties'})

List of custom properties

form_ref class-attribute instance-attribute 
form_ref: Optional[Any] = field(default=None, metadata={'wire_name': 'formRef'})

Form reference object

note class-attribute instance-attribute 
note: Optional[str] = None

Note used for notifications on status changes

planned_duration class-attribute instance-attribute 
planned_duration: Optional[int] = field(default=None, metadata={'wire_name': 'plannedDuration'})

Planned duration in days

planned_end_date class-attribute instance-attribute 
planned_end_date: Optional[str] = field(default=None, metadata={'wire_name': 'plannedEndDate'})

Date string of planned end date (due date)

planned_start_date class-attribute instance-attribute 
planned_start_date: Optional[str] = field(default=None, metadata={'wire_name': 'plannedStartDate'})

Date string of planned start date

priority class-attribute instance-attribute 
priority: Optional[str] = None

Priority value

project_id class-attribute instance-attribute 
project_id: Optional[str] = field(default=None, metadata={'wire_name': 'projectId'})

Project ID of the project the request belongs to

step_id class-attribute instance-attribute 
step_id: Optional[int] = field(default=None, metadata={'wire_name': 'stepId'})

Step ID indicating status

title class-attribute instance-attribute 
title: Optional[str] = None

Title of the request

UpdateTask dataclass 

UpdateTask(assignee_id: Optional[str] = None, custom_properties: Optional[List[CustomPropertyValuesInput]] = 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] = field(default=None, metadata={'wire_name': 'assigneeId'})

User ID of the assignee

custom_properties class-attribute instance-attribute 
custom_properties: Optional[List[CustomPropertyValuesInput]] = field(default=None, metadata={'wire_name': 'customProperties'})

List of custom properties

description class-attribute instance-attribute 
description: Optional[str] = None

Description of task

parent_id class-attribute instance-attribute 
parent_id: Optional[str] = field(default=None, metadata={'wire_name': 'parentId'})

Task ID of parent task

planned_duration class-attribute instance-attribute 
planned_duration: Optional[int] = field(default=None, metadata={'wire_name': 'plannedDuration'})

Planned duration in days

planned_end_date class-attribute instance-attribute 
planned_end_date: Optional[str] = field(default=None, metadata={'wire_name': 'plannedEndDate'})

Date string of planned end date

planned_start_date class-attribute instance-attribute 
planned_start_date: Optional[str] = field(default=None, metadata={'wire_name': 'plannedStartDate'})

Date string of planned start date

priority class-attribute instance-attribute 
priority: Optional[str] = None

Priority value

project_id class-attribute instance-attribute 
project_id: Optional[str] = field(default=None, metadata={'wire_name': 'projectId'})

Project ID that the task belongs to

step_id class-attribute instance-attribute 
step_id: Optional[int] = field(default=None, metadata={'wire_name': 'stepId'})

Step ID indicating the task status

title class-attribute instance-attribute 
title: Optional[str] = None

Title of task

ValueSchemaPropertyDefinition dataclass 

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

Definition: ValueSchemaPropertyDefinition

SeismicplannerClient 

SeismicplannerClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

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
token_provider Optional[TokenProvider]

Optional token provider. Defaults to ManagedIdentityTokenProvider.

 None
options Optional[ConnectorClientOptions]

Optional connector client options.

 None

Methods:

get_comments_async async 
get_comments_async(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) -> dict[str, Any] | None

Get comments

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

create_comment_async async 
create_comment_async(input: CreateCommentModel, space_id: str, node_id: str) -> dict[str, Any] | None

Create comment

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

get_comment_async async 
get_comment_async(space_id: str, node_id: str, comment_id: str) -> dict[str, Any] | None

Get comment

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

delete_comment_async async 
delete_comment_async(space_id: str, node_id: str, comment_id: str) -> None

Delete comment

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

update_comment_async async 
update_comment_async(input: UpdateCommentModel, space_id: str, node_id: str, comment_id: str) -> dict[str, Any] | None

Update comment

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

get_projects_async async 
get_projects_async(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) -> dict[str, Any] | None

Get projects

Get a list of projects with their attributes and associations.

delete_projects_async async 
delete_projects_async(space_id: str, ids: List[str], delete_tasks: Optional[bool] = None) -> dict[str, Any] | None

Delete projects

Delete one or more projects.

create_project_async async 
create_project_async(input: CreateProject, space_id: str) -> dict[str, Any] | None

Create project

Create a project.

get_project_async async 
get_project_async(space_id: str, project_id: str, associated_nodes_depth: Optional[int] = None, include_works: Optional[bool] = None) -> dict[str, Any] | None

Get project

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

delete_project_async async 
delete_project_async(space_id: str, project_id: str, delete_tasks: Optional[bool] = None) -> dict[str, Any] | None

Delete project

Delete a project.

update_project_async async 
update_project_async(input: UpdateProject, space_id: str, project_id: str) -> dict[str, Any] | None

Update a project

Update and return a project.

get_requests_async async 
get_requests_async(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) -> dict[str, Any] | None

Get requests

Get a list of requests.

delete_requests_async async 
delete_requests_async(input: DeleteRequest, space_id: str) -> dict[str, Any] | None

Delete requests

Bulk delete requests.

create_request_async async 
create_request_async(input: CreateRequest, space_id: str) -> dict[str, Any] | None

Create request

Create a request.

get_request_async async 
get_request_async(space_id: str, request_id: str) -> dict[str, Any] | None

Get request

Get a single request.

delete_request_async async 
delete_request_async(space_id: str, request_id: str) -> None

Delete request

Delete a request.

update_request_async async 
update_request_async(input: UpdateRequest, space_id: str, request_id: str) -> dict[str, Any] | None

Update request

Update a request.

get_status_schemas_async async 
get_status_schemas_async(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) -> dict[str, Any] | None

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)

get_status_schema_async async 
get_status_schema_async(space_id: str, status_schema_id: str) -> 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)

get_tasks_async async 
get_tasks_async(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) -> dict[str, Any] | None

Get tasks

Get a list of tasks.

create_task_async async 
create_task_async(input: CreateTask, space_id: str) -> dict[str, Any] | None

Create task

Create a task.

get_task_async async 
get_task_async(space_id: str, task_id: str) -> dict[str, Any] | None

Get task

Get a single task by ID.

delete_task_async async 
delete_task_async(space_id: str, task_id: str) -> dict[str, Any] | None

Delete task

Delete a task.

update_task_async async 
update_task_async(input: UpdateTask, space_id: str, task_id: str) -> dict[str, Any] | None

Update task

Update an existing task.