v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB

Obligations

Create an Obligation

Create a new obligation.

OAuth Scope required: public.obligations.createObligations

post/obligations

Headers

x-as-user-emailstring

Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-idstring

Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Request body

namestring required

The name of the obligation

propertiesobject

A key:value map of properties to add. The two below are examples. More details on the properties can be found in the Obligation Properties article.

obligationTypeKeystring[] required

The key of the obligation type to be added to the obligation. Only one obligation type can be added or updated per obligation, currently. More info on obligation types can be found in the Obligation Types article.

parentIdstring required

The ID of the contract to create the new obligation as a child of. This is useful for creating a new obligation as a child of an existing obligation.

sourceObligationIdstring

Associates this obligation with a source obligation. For example, associating a new obligation with a source obligation that has a triggering condition.

descriptionstring

Human-readable description of this obligation.

statusstring

The status of the obligation. Only valid when sourceObligationId is present.

dueDatestring

The due date for the obligation (yyyy-MM-dd). Only valid when sourceObligationId is present.

assigneeUserIdstring

The user assigned to this obligation. Only valid when sourceObligationId is present.

Response

201

idstring required

The unique identifier of the obligation

ironcladIdstring required

Readable Ironclad ID of the obligation

namestring required

The name of the obligation

propertiesRecordProperties required

The record properties associated with the record

lastUpdatedstring

The last updated date of the obligation

namedTypeIdsstring[]

The unique identifiers of the types associated with the obligation. These IDs are tied with the Named Type of obligations, like 'Breach Notice', 'Compliance' and so on.

parentReadableIdstring

The parent readable id of the obligation

parentRecordNamestring

The parent record name of the obligation

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "ironcladId": "OB-1",
  "name": "Obligation XYZ",
  "lastUpdated": "2021-01-01T00:00:00Z",
  "namedTypeIds": [
    "eda20988-6b99-404b-99dc-866b84b63883"
  ],
  "parentReadableId": "IC-1",
  "parentRecordName": "Parent Record"
}