Tasks

Tasks

Creates a new task record that does not already exist.

This method will auto-generate an ID and create a new task. If an ID is specified for the task, an error will be thrown.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The task that you would like to be saved.

application
string (Application)

The application with which this task is affiliated

assignee_id
string (Assignee)

The user to whom this task is assigned

associated_contact_id
string (Associated Contact)

If the task is associated with a contact

associated_organization_id
string (Associated Organization)

If the task is associated with a contact

Array of objects
Array of objects (Custom Field Values)
description
string (Description)

A description of this task

due_date
required
string (Due Date)

The due date

id
required
string (ID) ^[\w|-]+$

The unique, string identifier of this task

name
required
string (Name)

The name of the task

order_id
string (Order)

The order with which this task is associated

order_line_item_id
string (Order Line Item)

The order line item with which this task is associated

owner_id
required
string (Owner)

The user that owns this task

priority
string (Priority)
Enum: "high" "low" "normal" "urgent"
queue_id
string (Queue)

The queue to which this task is assigned

queue_priority
number <float> (Queue Priority)

The priority in the queue

remind_assignee
boolean (Remind Assignee)

If true, the assignee should be reminded of this task via email

reminder_date
required
string <date-time> (Reminder Date)

The date to remind

status
required
string (Status)
Enum: "completed" "deferred" "open" "waiting for someone else"
sys_bulk_load_at
string (Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

Array of objects
sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3
boolean (Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_last_security_context
object (Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

task_group_id
string (Task Group)

When tasks are linked, this is the UUID of the grouping

type_id
required
string (Type)

The type of task

Responses
200The task was saved successfully.
400The task you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The task could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add task based on tenant limits.
500General server error.
post/tasks/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "application": "string",
  • "assignee_id": "string",
  • "associated_contact_id": "string",
  • "associated_organization_id": "string",
  • "associated_records": [
    ],
  • "custom_field_values": [
    ],
  • "description": "string",
  • "due_date": "string",
  • "id": "string",
  • "name": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "owner_id": "string",
  • "priority": "high",
  • "queue_id": "string",
  • "queue_priority": 0,
  • "remind_assignee": true,
  • "reminder_date": "2019-08-24T14:15:22Z",
  • "status": "completed",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_calculated_field_error": "string",
  • "sys_calculated_field_errors": [
    ],
  • "sys_configuration_snapshot_id": "string",
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_deleted_by_id": "string",
  • "sys_directive": "string",
  • "sys_external_id": "string",
  • "sys_has_files_in_s3": true,
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_by_id": "string",
  • "sys_last_security_context": { },
  • "sys_locked": true,
  • "sys_snapshot_base_version": 0,
  • "sys_version": 0,
  • "task_group_id": "string",
  • "type_id": "string"
}
Response samples
application/json
{
  • "application": "string",
  • "assignee_id": "string",
  • "associated_contact_id": "string",
  • "associated_organization_id": "string",
  • "associated_records": [
    ],
  • "custom_field_values": [
    ],
  • "description": "string",
  • "due_date": "string",
  • "id": "string",
  • "name": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "owner_id": "string",
  • "priority": "high",
  • "queue_id": "string",
  • "queue_priority": 0,
  • "remind_assignee": true,
  • "reminder_date": "2019-08-24T14:15:22Z",
  • "status": "completed",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_calculated_field_error": "string",
  • "sys_calculated_field_errors": [
    ],
  • "sys_configuration_snapshot_id": "string",
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_deleted_by_id": "string",
  • "sys_directive": "string",
  • "sys_external_id": "string",
  • "sys_has_files_in_s3": true,
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_by_id": "string",
  • "sys_last_security_context": { },
  • "sys_locked": true,
  • "sys_snapshot_base_version": 0,
  • "sys_version": 0,
  • "task_group_id": "string",
  • "type_id": "string"
}

Returns a list of records with the specified assignee_id

Returns a list of records with the specified assignee_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

assignee_id
required
string

The assignee_id to use to for record lookup

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/tasks/{tenantId}/assignee/{assignee_id}
Request samples
curl -i -X GET \
  'https://platform.api.rhythmsoftware.com/tasks/:tenantId/assignee/:assignee_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified associated_contact_id

Returns a list of records with the specified associated_contact_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

associated_contact_id
required
string

The associated_contact_id to use to for record lookup

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/tasks/{tenantId}/associatedContact/{associated_contact_id}
Request samples
curl -i -X GET \
  'https://platform.api.rhythmsoftware.com/tasks/:tenantId/associatedContact/:associated_contact_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified associated_organization_id

Returns a list of records with the specified associated_organization_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

associated_organization_id
required
string

The associated_organization_id to use to for record lookup

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/tasks/{tenantId}/associatedOrganization/{associated_organization_id}
Request samples
curl -i -X GET \
  'https://platform.api.rhythmsoftware.com/tasks/:tenantId/associatedOrganization/:associated_organization_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified sys_search_associated_record_id

Returns a list of records with the specified sys_search_associated_record_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

service
required
string

The service

record_id
required
string

The record id

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/tasks/{tenantId}/associatedRecord/{service}/{record_id}
Request samples
curl -i -X GET \
  'https://platform.api.rhythmsoftware.com/tasks/:tenantId/associatedRecord/:service/:record_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified owner_id

Returns a list of records with the specified owner_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

owner_id
required
string

The owner_id to use to for record lookup

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/tasks/{tenantId}/owner/{owner_id}
Request samples
curl -i -X GET \
  'https://platform.api.rhythmsoftware.com/tasks/:tenantId/owner/:owner_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified queue_id

Returns a list of records with the specified queue_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

queue_id
required
string

The queue_id to use to for record lookup

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/tasks/{tenantId}/queue/{queue_id}
Request samples
curl -i -X GET \
  'https://platform.api.rhythmsoftware.com/tasks/:tenantId/queue/:queue_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Searches for tasks using predefined parameters

Searches for tasks using predefined parameters

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
exclusiveStartKey
string

The start key for the search, for paging support

fieldsToReturn
string

The fields that you want to retrieve; if omitted, the entire object is returned

Request Body schema: application/json

The task that you would like to be saved.

name
Array of strings (Name)
priority
Array of strings (Priority)
type_id
Array of strings (Type)
Responses
200The task search was saved successfully.
400The task you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The task could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add task based on tenant limits.
500General server error.
post/tasks/{tenantId}/search
Request samples
    1 more
    Python
application/json
{
  • "name": [
    ],
  • "priority": [
    ],
  • "type_id": [
    ]
}
Response samples
application/json
{
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified task_group_id

Returns a list of records with the specified task_group_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

task_group_id
required
string

The task_group_id to use to for record lookup

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/tasks/{tenantId}/taskGroup/{task_group_id}
Request samples
curl -i -X GET \
  'https://platform.api.rhythmsoftware.com/tasks/:tenantId/taskGroup/:task_group_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a task from the system by its ID.

This method will delete a task with the specified ID.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the task to delete.

Responses
200The task was deleted successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The task could not be found.
409The task could not be deleted because other objects refers to/depends on this one.
429Limit exceeded... unable to delete task based on tenant limits.
500General server error.
delete/tasks/{tenantId}/{id}
Request samples
curl -i -X DELETE \
  https://platform.api.rhythmsoftware.com/tasks/:tenantId/:id \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
"string"

Returns a task from the system by its ID.

This method will look up a task by the specified ID and return it back.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the task to return.

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentRead
string

Indicates the API should force a consistent read on the data source.

Responses
200The task was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The task could not be found.
429Limit exceeded... unable to retrieve task based on tenant limits.
500General server error.
get/tasks/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://platform.api.rhythmsoftware.com/tasks/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "application": "string",
  • "assignee_id": "string",
  • "associated_contact_id": "string",
  • "associated_organization_id": "string",
  • "associated_records": [
    ],
  • "custom_field_values": [
    ],
  • "description": "string",
  • "due_date": "string",
  • "id": "string",
  • "name": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "owner_id": "string",
  • "priority": "high",
  • "queue_id": "string",
  • "queue_priority": 0,
  • "remind_assignee": true,
  • "reminder_date": "2019-08-24T14:15:22Z",
  • "status": "completed",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_calculated_field_error": "string",
  • "sys_calculated_field_errors": [
    ],
  • "sys_configuration_snapshot_id": "string",
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_deleted_by_id": "string",
  • "sys_directive": "string",
  • "sys_external_id": "string",
  • "sys_has_files_in_s3": true,
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_by_id": "string",
  • "sys_last_security_context": { },
  • "sys_locked": true,
  • "sys_snapshot_base_version": 0,
  • "sys_version": 0,
  • "task_group_id": "string",
  • "type_id": "string"
}

Partially updates a task with the specified ID.

This method will patch an existing task with the specified ID, using the HTTP PATCH specification.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the task to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array
op
required
string (Op)

The operation

Enum: "add" "copy" "move" "remove" "replace" "test"
path
required
string (Path)

The JSON path

value
string (Value)

The updated value

Responses
200The task was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The task could not be found.
409The task could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve task based on tenant limits.
500General server error.
patch/tasks/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "application": "string",
  • "assignee_id": "string",
  • "associated_contact_id": "string",
  • "associated_organization_id": "string",
  • "associated_records": [
    ],
  • "custom_field_values": [
    ],
  • "description": "string",
  • "due_date": "string",
  • "id": "string",
  • "name": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "owner_id": "string",
  • "priority": "high",
  • "queue_id": "string",
  • "queue_priority": 0,
  • "remind_assignee": true,
  • "reminder_date": "2019-08-24T14:15:22Z",
  • "status": "completed",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_calculated_field_error": "string",
  • "sys_calculated_field_errors": [
    ],
  • "sys_configuration_snapshot_id": "string",
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_deleted_by_id": "string",
  • "sys_directive": "string",
  • "sys_external_id": "string",
  • "sys_has_files_in_s3": true,
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_by_id": "string",
  • "sys_last_security_context": { },
  • "sys_locked": true,
  • "sys_snapshot_base_version": 0,
  • "sys_version": 0,
  • "task_group_id": "string",
  • "type_id": "string"
}

Updates a task with the specified ID.

This method will update an existing task with the specified ID.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the task to update.

Request Body schema: application/json

The updated task that will be saved.

application
string (Application)

The application with which this task is affiliated

assignee_id
string (Assignee)

The user to whom this task is assigned

associated_contact_id
string (Associated Contact)

If the task is associated with a contact

associated_organization_id
string (Associated Organization)

If the task is associated with a contact

Array of objects
Array of objects (Custom Field Values)
description
string (Description)

A description of this task

due_date
required
string (Due Date)

The due date

id
required
string (ID) ^[\w|-]+$

The unique, string identifier of this task

name
required
string (Name)

The name of the task

order_id
string (Order)

The order with which this task is associated

order_line_item_id
string (Order Line Item)

The order line item with which this task is associated

owner_id
required
string (Owner)

The user that owns this task

priority
string (Priority)
Enum: "high" "low" "normal" "urgent"
queue_id
string (Queue)

The queue to which this task is assigned

queue_priority
number <float> (Queue Priority)

The priority in the queue

remind_assignee
boolean (Remind Assignee)

If true, the assignee should be reminded of this task via email

reminder_date
required
string <date-time> (Reminder Date)

The date to remind

status
required
string (Status)
Enum: "completed" "deferred" "open" "waiting for someone else"
sys_bulk_load_at
string (Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

Array of objects
sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3
boolean (Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_last_security_context
object (Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

task_group_id
string (Task Group)

When tasks are linked, this is the UUID of the grouping

type_id
required
string (Type)

The type of task

Responses
200The task was updated successfully.
400The task supplied was not valid.
401Unauthorized.
403Forbidden.
404The task could not be found.
409The task could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve task based on tenant limits.
500General server error.
put/tasks/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "application": "string",
  • "assignee_id": "string",
  • "associated_contact_id": "string",
  • "associated_organization_id": "string",
  • "associated_records": [
    ],
  • "custom_field_values": [
    ],
  • "description": "string",
  • "due_date": "string",
  • "id": "string",
  • "name": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "owner_id": "string",
  • "priority": "high",
  • "queue_id": "string",
  • "queue_priority": 0,
  • "remind_assignee": true,
  • "reminder_date": "2019-08-24T14:15:22Z",
  • "status": "completed",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_calculated_field_error": "string",
  • "sys_calculated_field_errors": [
    ],
  • "sys_configuration_snapshot_id": "string",
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_deleted_by_id": "string",
  • "sys_directive": "string",
  • "sys_external_id": "string",
  • "sys_has_files_in_s3": true,
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_by_id": "string",
  • "sys_last_security_context": { },
  • "sys_locked": true,
  • "sys_snapshot_base_version": 0,
  • "sys_version": 0,
  • "task_group_id": "string",
  • "type_id": "string"
}
Response samples
application/json
{
  • "application": "string",
  • "assignee_id": "string",
  • "associated_contact_id": "string",
  • "associated_organization_id": "string",
  • "associated_records": [
    ],
  • "custom_field_values": [
    ],
  • "description": "string",
  • "due_date": "string",
  • "id": "string",
  • "name": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "owner_id": "string",
  • "priority": "high",
  • "queue_id": "string",
  • "queue_priority": 0,
  • "remind_assignee": true,
  • "reminder_date": "2019-08-24T14:15:22Z",
  • "status": "completed",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_calculated_field_error": "string",
  • "sys_calculated_field_errors": [
    ],
  • "sys_configuration_snapshot_id": "string",
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_deleted_by_id": "string",
  • "sys_directive": "string",
  • "sys_external_id": "string",
  • "sys_has_files_in_s3": true,
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_by_id": "string",
  • "sys_last_security_context": { },
  • "sys_locked": true,
  • "sys_snapshot_base_version": 0,
  • "sys_version": 0,
  • "task_group_id": "string",
  • "type_id": "string"
}