Transposit MC (version v2.*.*)

Functional Transposit Public MC API

add_activity_field_values#

Add items to a activity field multi-value

Parameters

fieldId (required)#

Type: string

id (required)#

Type: integer

team (required)#

Type: string

$body#

Type: string

source#

Type: string

Adds a related link to an activity

Parameters

id (required)#

Type: integer

team (required)#

Type: string

$body#

Type: object

{
"text" : "Required string",
"url" : "Required string"
}

source#

Type: string

close_activity#

Closes an activity

Parameters

id (required)#

Type: integer

team (required)#

Type: string

source#

Type: string

create_activity#

Creates a new activity. type can be either an activity type's name or id. The fields that can be set for the Activity can be retrieved from the List fields for an activity type endpoint.

Parameters

team (required)#

Type: string

$body#

Type: object

{
"description" : "string",
"channelName" : "string",
"originatingEventMetadata" : {
"eventId" : "Required string",
"alertId" : "string"
},
"type" : "Required string",
"title" : "Required string",
"fields" : "object"
}

source#

Type: string

create_subscription#

Subscribes to an activity. Specify the types of events to subscribe to, and the app and operation to be called when a subscribed event type occurs.

Parameters

id (required)#

Type: integer

team (required)#

Type: string

$body#

Type: object

{
"appId" : "The app that will be called when an event occurs, formatted as `orgId/app_name:tag`. e.g. `transposit/transposit_notify_jira:v1.*.*`.",
"operationName" : "The specific operation within the app that will be called when an event occurs.",
"eventTypes" : [ "string. Possible values: DASHBOARD_UPDATE | COMMANDER_UPDATE | LINK_UPDATE | SEVERITY_UPDATE" ],
"parameters" : { }
}

delete_activity_field_value#

Unsets all values of a single field for an activity

Parameters

fieldId (required)#

Type: string

id (required)#

Type: integer

team (required)#

Type: string

source#

Type: string

delete_commander#

deletes the activity's commander

Parameters

id (required)#

Type: integer

team (required)#

Type: string

source#

Type: string

Deletes a related link from an activity

Parameters

id (required)#

Type: integer

team (required)#

Type: string

$body#

Type: object

{
"id" : "integer",
"url" : "string"
}

source#

Type: string

delete_severity#

Deletes an activity's severity, setting it to None

Parameters

id (required)#

Type: integer

team (required)#

Type: string

source#

Type: string

delete_subscription#

Deletes subscription by subscription id. The subscription id can be obtained from the list_subscriptions endpoint.

Parameters

id (required)#

Type: integer

subscription (required)#

Type: uuid

team (required)#

Type: string

get_activity#

Gets the details of an activity.

Parameters

id (required)#

Type: integer

team (required)#

Type: string

get_activity_defaults#

Returns activity creation defaults

Parameters

team (required)#

Type: string

get_activity_field_value#

Returns the JSON for a single field for an activity (may be multi-value)

Parameters

fieldId (required)#

Type: string

id (required)#

Type: integer

team (required)#

Type: string

get_commander#

gets the activity's commander

Parameters

id (required)#

Type: integer

team (required)#

Type: string

Gets related links for an activity

Parameters

id (required)#

Type: integer

team (required)#

Type: string

get_run_state#

Get the state of a run

Parameters

runId (required)#

Type: string

team (required)#

Type: string

get_severity#

Gets an activity's severity

Parameters

id (required)#

Type: integer

team (required)#

Type: string

Link a run to a stream

Parameters

runId (required)#

Type: string

team (required)#

Type: string

$body#

Type: object

{
"activityPublicId" : "integer",
"triggerId" : "integer"
}

source#

Type: string

list_activities#

Lists 100 most recent activities. Can be filtered by activity status or type

Parameters

team (required)#

Type: string

status#

Type: string

Potential values: INCIDENT_OPEN, INCIDENT_CLOSED

type#

Type: string

list_activity_types#

List activity types for a team

Parameters

team (required)#

Type: string

list_fields_for_activity#

Gets all possible fields for an activity. This includes field types and configurations

Parameters

id (required)#

Type: integer

team (required)#

Type: string

list_fields_for_activity_type#

Gets the fields for an activity type.

Parameters

team (required)#

Type: string

type (required)#

Activity type name or id.

Type: string

list_subscriptions#

Lists subscriptions for an activity

Parameters

id (required)#

Type: integer

team (required)#

Type: string

list_updates#

Lists updates for an activity.

Parameters

id (required)#

Type: integer

team (required)#

Type: string

post_update#

Posts an update to an activity

Parameters

id (required)#

Type: integer

team (required)#

Type: string

$body#

Type: object

{
"originatingEventMetadata" : [ {
"eventId" : "Required string",
"alertId" : "string"
} ],
"eventIds" : [ "string" ],
"updateMessage" : "Required string"
}

source#

Type: string

remove_activity_field_values#

Remove only matching items from a activity field multi-value

Parameters

fieldId (required)#

Type: string

id (required)#

Type: integer

team (required)#

Type: string

$body#

Type: string

source#

Type: string

reopen_activity#

Reopens an activity

Parameters

id (required)#

Type: integer

team (required)#

Type: string

source#

Type: string

set_activity_field_value#

Sets the value of a single field for an activity (may be multi-value)

Parameters

fieldId (required)#

Type: string

id (required)#

Type: integer

team (required)#

Type: string

$body#

Type: string

source#

Type: string

set_commander#

sets the activity's commander

Parameters

id (required)#

Type: integer

team (required)#

Type: string

$body#

Type: object

{
"id" : "Required string"
}

source#

Type: string

set_run_state#

Set the state of a run

Parameters

runId (required)#

Type: string

team (required)#

Type: string

$body#

Type: object

{
"state" : "Required string"
}

source#

Type: string

set_severity#

Sets an activity's severity

Parameters

id (required)#

Type: integer

team (required)#

Type: string

$body#

Type: object

{
"severity" : "Required string. Possible values: SEV0 | SEV1 | SEV2 | SEV3 | SEV4 | SEV5"
}

source#

Type: string

synced_activities#

Gets list of synced activities & sync destinations for given sync id + link id

Parameters

linkId (required)#

Type: string

syncId (required)#

Type: integer

team (required)#

Type: string

Unlink a run from a stream

Parameters

runId (required)#

Type: string

team (required)#

Type: string

$body#

Type: object

{
"activityPublicId" : "integer",
"triggerId" : "integer"
}

source#

Type: string

update_activity#

Updates an existing activity. The fields that can be set for the Activity can be retrieved from the List fields for an activity type endpoint.

Parameters

id (required)#

Type: integer

team (required)#

Type: string

$body#

Type: object

{
"description" : "string",
"title" : "string",
"fields" : "object"
}

source#

Type: string