Socotra Work Management API
The Work Management API from Socotra — 39 operation(s) for work management.
The Work Management API from Socotra — 39 operation(s) for work management.
openapi: 3.0.1
info:
title: Socotra Insurance Suite OpenAPI Definition Work Management API
description: Socotra Insurance Suite API
termsOfService: https://www.socotra.com
version: v0
servers:
- url: /
description: Generated server url
tags:
- name: Work Management
paths:
/work-management/{tenantLocator}/workplans:
post:
operationId: createWorkplan
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkplanCreateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/Workplan'
deprecated: false
x-securityGroup: workplans
x-securityPermission:
- write
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/workgroups:
post:
operationId: createWorkgroup
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkgroupCreateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/WorkgroupResponse'
deprecated: false
x-securityGroup: workgroups
x-securityPermission:
- write
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/userAssociations:
post:
operationId: makeUserAssociation
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserAssociationCreateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/UserAssociation'
deprecated: false
x-securityGroup: user-associations
x-securityPermission:
- write
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/tasks:
post:
operationId: addTask
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskCreateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/Task'
deprecated: false
x-securityGroup: tasks
x-securityPermission:
- write
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/tasks/{locator}/number/set:
post:
operationId: setTaskNumber
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: locator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: taskNumber
in: query
required: true
schema:
type: string
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/Task'
deprecated: false
x-securityGroup: tasks
x-securityPermission:
- write
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/tasks/{locator}/number/generate:
post:
operationId: generateTaskNumber
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: locator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/Task'
deprecated: false
x-securityGroup: tasks
x-securityPermission:
- write
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/assignments:
post:
operationId: autoAssign
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AutoAssignmentCreateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/AutoAssignmentResponse'
deprecated: false
x-securityGroup: assignments
x-securityPermission:
- write
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/workplans/{locator}:
get:
operationId: getWorkplan
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: locator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/Workplan'
deprecated: false
x-securityGroup: workplans
x-securityPermission:
- read
deprecated: false
tags:
- Work Management
patch:
operationId: patchWorkplan
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: locator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkplanPatchRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/Workplan'
deprecated: false
x-securityGroup: workplans
x-securityPermission:
- write
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/workplans/{locator}/discard:
patch:
operationId: discardWorkplan
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: locator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/Workplan'
deprecated: false
x-securityGroup: workplans
x-securityPermission:
- write
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/workgroups/{workgroupLocator}:
get:
operationId: getWorkgroup
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: workgroupLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/WorkgroupResponse'
deprecated: false
x-securityGroup: workgroups
x-securityPermission:
- read
deprecated: false
tags:
- Work Management
patch:
operationId: patchWorkgroup
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: workgroupLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkgroupPatchRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/WorkgroupResponse'
deprecated: false
x-securityGroup: workgroups
x-securityPermission:
- write
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/workgroups/{workgroupLocator}/discard:
patch:
operationId: discardWorkgroup
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: workgroupLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/WorkgroupResponse'
deprecated: false
x-securityGroup: workgroups
x-securityPermission:
- write
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/userAssociations/{userAssociationLocator}/uncomplete:
patch:
operationId: uncompleteUserAssociation
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: userAssociationLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/UserAssociation'
deprecated: false
x-securityGroup: user-associations
x-securityPermission:
- write
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/userAssociations/{userAssociationLocator}/disassociate:
patch:
operationId: disassociateUserAssociation
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: userAssociationLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/UserAssociation'
deprecated: false
x-securityGroup: user-associations
x-securityPermission:
- write
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/userAssociations/{userAssociationLocator}/complete:
patch:
operationId: completeUserAssociation
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: userAssociationLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/UserAssociation'
deprecated: false
x-securityGroup: user-associations
x-securityPermission:
- write
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/tasks/{locator}:
get:
operationId: getTask
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: locator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/Task'
deprecated: false
x-securityGroup: tasks
x-securityPermission:
- read
deprecated: false
tags:
- Work Management
patch:
operationId: updateTask
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: locator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskUpdateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/Task'
deprecated: false
x-securityGroup: tasks
x-securityPermission:
- write
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/tasks/{locator}/unassign:
patch:
operationId: unassignTask
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: locator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/Task'
deprecated: false
x-securityGroup: tasks
x-securityPermission:
- write
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/tasks/{locator}/complete:
patch:
operationId: completeTask
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: locator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/Task'
deprecated: false
x-securityGroup: tasks
x-securityPermission:
- write
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/tasks/{locator}/cancel:
patch:
operationId: cancelTask
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: locator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/Task'
deprecated: false
x-securityGroup: tasks
x-securityPermission:
- write
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/tasks/{locator}/assign/{userLocator}:
patch:
operationId: assignTask
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: locator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: userLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/Task'
deprecated: false
x-securityGroup: tasks
x-securityPermission:
- write
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/tasks/{locator}/activate:
patch:
operationId: activateTask
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: locator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/Task'
deprecated: false
x-securityGroup: tasks
x-securityPermission:
- write
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/qualifications/{userLocator}:
get:
operationId: getUserQualifications
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: userLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
additionalProperties:
type: string
deprecated: false
x-securityGroup: qualifications
x-securityPermission:
- read
deprecated: false
tags:
- Work Management
patch:
operationId: updateUserQualifications
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: userLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QualificationsUpdateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
additionalProperties:
type: string
deprecated: false
x-securityGroup: qualifications
x-securityPermission:
- write
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/workplans/list:
get:
operationId: listWorkplans
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: offset
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
- name: count
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ListPageResponseWorkplan'
deprecated: false
x-securityGroup: workplans
x-securityPermission:
- read
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/workgroups/list:
get:
operationId: listWorkgroups
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: user
in: query
required: false
schema:
type: string
format: uuid
deprecated: false
- name: offset
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
- name: count
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ListPageResponseWorkgroupResponse'
deprecated: false
x-securityGroup: workgroups
x-securityPermission:
- read
- list
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/userAssociations/{referenceType}/{referenceLocator}/{userAssociationState}/list:
get:
operationId: listAssignedUsers
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: referenceType
in: path
required: true
schema:
type: string
enum:
- account
- quickQuote
- quote
- policy
- transaction
- invoice
- underwritingFlag
- payment
- quoteGroup
- inquiry
deprecated: false
- name: referenceLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: userAssociationState
in: path
required: true
schema:
type: string
enum:
- active
- completed
- disassociated
- discarded
deprecated: false
- name: offset
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
- name: count
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ListPageResponseUserAssociation'
deprecated: false
x-securityGroup: user-associations
x-securityPermission:
- read
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/userAssociations/{referenceType}/{referenceLocator}/history/list:
get:
operationId: listReferenceUserAssociationsHistory
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: referenceType
in: path
required: true
schema:
type: string
enum:
- account
- quickQuote
- quote
- policy
- transaction
- invoice
- underwritingFlag
- payment
- quoteGroup
- inquiry
deprecated: false
- name: referenceLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: offset
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
- name: count
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ListPageResponseUserAssociation'
deprecated: false
x-securityGroup: user-associations
x-securityPermission:
- read
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/userAssociations/{locator}:
get:
operationId: getUserAssociation
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: locator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/UserAssociation'
deprecated: false
x-securityGroup: user-associations
x-securityPermission:
- read
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/userAssociations/{locator}/history/list:
get:
operationId: listUserAssociationHistory
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: locator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: offset
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
- name: count
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ListPageResponseUserAssociation'
deprecated: false
x-securityGroup: user-associations
x-securityPermission:
- read
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/userAssociations/user/{userLocator}/{userAssociationState}/list:
get:
operationId: listUserUserAssociations
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: userLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: userAssociationState
in: path
required: true
schema:
type: string
enum:
- active
- completed
- disassociated
- discarded
deprecated: false
- name: offset
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
- name: count
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ListPageResponseUserAssociation'
deprecated: false
x-securityGroup: user-associations
x-securityPermission:
- read
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/userAssociations/user/{userLocator}/qualifiedRoles/list:
get:
operationId: listUserQualifiedRoles
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: userLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: referenceType
in: query
required: false
schema:
type: string
enum:
- account
- quickQuote
- quote
- policy
- transaction
- invoice
- underwritingFlag
- payment
- quoteGroup
- inquiry
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/UserQualifiedRolesResponse'
deprecated: false
x-securityGroup: user-associations
x-securityPermission:
- read
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/userAssociations/user/{userLocator}/history/list:
get:
operationId: listUserUserAssociationsHistory
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: userLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: offset
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
- name: count
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ListPageResponseUserAssociation'
deprecated: false
x-securityGroup: user-associations
x-securityPermission:
- read
deprecated: false
tags:
- Work Management
/work-management/{tenantLocator}/tasks/{referenceType}/{referenceLocator}/list:
get:
operationId: searchTasks
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: referenceType
in: path
required: true
schema:
type: string
enum:
- account
- quickQuote
- quote
- policy
- transaction
- invoice
# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/socotra/refs/heads/main/openapi/socotra-work-management-api-openapi.yml