RecordsListAll400Response
{
"type": "object",
"properties": {}
}
RecordsListAllResponse
{
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecordModel"
}
},
"page": {
"type": "integer",
"default": 0,
"example": 0
},
"count": {
"type": "integer",
"default": 0,
"example": 1234
},
"pageSize": {
"type": "integer",
"default": 0,
"example": 20
}
}
}
RecordsRemoveAttachmentResponse
{
"oneOf": [
{
"$ref": "#/components/schemas/BadRequestErrorRecordIDNotFound"
},
{
"$ref": "#/components/schemas/BadRequestErrorRecordAttachmentIDNotFound"
}
]
}
RecordsReplaceMetadataRequest
{
"type": "object",
"required": [
"type",
"name",
"properties"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the record."
},
"type": {
"type": "string",
"description": "The type of record to be created. You can view available record types by retrieving records metadata."
},
"parent": {
"type": "object",
"properties": {
"recordId": {
"type": "string",
"example": "17009e0d-z2e9-425d-a85b-1cf152773efg"
}
},
"description": "Object containing Record IDs or Ironclad IDs to be set as the parent of the current record."
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecordPropertyLinkModel"
},
"description": "List of objects containing the Record IDs or Ironclad IDs of the records to be set as child records of the current record."
},
"properties": {
"type": "object",
"properties": {
"agreementDate": {
"type": "object",
"properties": {
"type": {
"type": "string",
"default": "date"
},
"value": {
"type": "string",
"description": "UTC date (e.g. `2018-05-08T00:00:00-07:00`)"
}
},
"description": "The date of the agreement."
},
"counterpartyName": {
"type": "object",
"properties": {
"type": {
"type": "string",
"default": "string"
},
"value": {
"type": "string",
"description": "The name of the counterparty."
}
},
"description": "The name of the counterparty."
}
},
"description": "Object containing key/value pairs of metadata attached to the record. The key you specify must have a value with a supported type as outlined in the Supported Property Types section."
}
}
}
RecordsReplaceMetadataResponse
{
"type": "object",
"properties": {}
}
RecordsUpdateMetadata404Response
{
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "NOT_FOUND"
},
"param": {
"type": "string",
"example": "parameter identifier"
},
"message": {
"type": "string",
"example": "not found"
}
}
}
RecordsUpdateMetadataRequest
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the Record."
},
"type": {
"type": "string",
"description": "The type of Record."
},
"addLinks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecordPropertyLinkModel"
},
"description": "List of objects containing the Record IDs or Ironclad IDs of the records to link. For an explanation of Record IDs or Ironclad IDs and how to find them, see [Getting Started](https://developer.ironcladapp.com/reference/getting-started-api)."
},
"setParent": {
"type": "object",
"properties": {
"recordId": {
"type": "string",
"example": "17009e0d-z2e9-425d-a85b-1cf152773efg"
}
},
"description": "Object containing Record IDs or Ironclad IDs to be set as the parent of the current record."
},
"addChildren": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecordPropertyLinkModel"
},
"description": "List of objects containing the Record IDs or Ironclad IDs of the records to be set as child records of the current record."
},
"removeLinks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecordPropertyLinkModel"
},
"description": "List of objects containing the Record IDs or Ironclad IDs of the record links to remove. For an explanation of Record IDs or Ironclad IDs and how to find them, see [Getting Started](https://developer.ironcladapp.com/reference/getting-started-api)."
},
"removeParent": {
"type": "boolean",
"example": false,
"description": "Boolean flag to indicate if the parent id should be removed for the current record."
},
"addProperties": {
"type": "object",
"properties": {
"agreementDate": {
"type": "object",
"properties": {
"type": {
"type": "string",
"default": "date",
"example": "date"
},
"value": {
"type": "string",
"example": "2018-05-08T00:00:00-07:00"
}
}
},
"counterpartyName": {
"type": "object",
"properties": {
"type": {
"type": "string",
"default": "string"
},
"value": {
"type": "string",
"example": "Jane Doe"
}
}
}
},
"description": "A key:value map of properties to add. The two below are examples."
},
"removeChildren": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecordPropertyLinkModel"
},
"description": "List of objects containing the Record IDs or Ironclad IDs of the child records to be removed from the current record."
},
"removeProperties": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of record property ids to be removed (e.g., ['counterpartyAddress', 'agreementExpirationDate'])"
}
}
}
RecordsUpdateMetadataResponse
{
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "MISSING_PARAM"
},
"param": {
"type": "string",
"example": "parameter identifier"
},
"message": {
"type": "string",
"example": "reason why something has gone wrong"
}
}
}
RecordsUploadSmartImportRecord400Response
{
"type": "object",
"properties": {
"code": {
"type": "string"
},
"param": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
RecordsUploadSmartImportRecord403Response
{
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
RecordsUploadSmartImportRecord404Response
{
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
RecordsUploadSmartImportRecordRequest
{
"type": "object",
"required": [
"attachment"
],
"properties": {
"attachment": {
"type": "string",
"format": "binary",
"description": "Must be a binary. Base64 is not accepted at this time."
},
"recordType": {
"type": "string",
"format": "string",
"default": "imported",
"description": "Upload a smart import record as an existing record type. Cannot provide alongside newRecordTypeId and newRecordTypeDisplayName. Defaults to Imported."
},
"newRecordTypeId": {
"type": "string",
"description": "The record type ID for a not-yet-existing record type. Must be provided along with a newRecordTypeDisplayName"
},
"newRecordTypeDisplayName": {
"type": "string",
"format": "string",
"description": "The display name of the new record type to create."
}
}
}
RecordsUploadSmartImportRecordResponse
{
"type": "object",
"properties": {
"importId": {
"type": "string",
"example": "55ez635d-f2g9-5419-gs34-8h1jx4s733q9"
},
"recordId": {
"type": "string",
"example": "17fe582d-e1e0-4000-bf65-3d2ec2c500a4",
"description": "Record ID of the new created record"
},
"remainingCredits": {
"type": "number",
"example": 50
}
}
}
RecordsUploadSmartImportRecordWithPredictions400Response
{
"type": "object",
"properties": {
"code": {
"type": "string"
},
"param": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
RecordsUploadSmartImportRecordWithPredictions403Response
{
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
RecordsUploadSmartImportRecordWithPredictions404Response
{
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
RecordsUploadSmartImportRecordWithPredictionsRequest
{
"type": "object",
"required": [
"attachment",
"recordType"
],
"properties": {
"attachment": {
"type": "string",
"format": "binary",
"description": "Must be a binary. Base64 is not accepted at this time."
},
"recordType": {
"type": "string",
"format": "string",
"default": "imported",
"description": "Upload a smart import record as an existing record type. Cannot provide alongside newRecordTypeId and newRecordTypeDisplayName. Defaults to Imported."
},
"newRecordTypeId": {
"type": "string",
"description": "The record type ID for a not-yet-existing record type. Must be provided along with a newRecordTypeDisplayName"
},
"newRecordTypeDisplayName": {
"type": "string",
"format": "string",
"description": "The display name of the new record type to create."
}
}
}
RecordsUploadSmartImportRecordWithPredictionsResponse
{
"type": "object",
"properties": {
"importId": {
"type": "string",
"example": "55ez635d-f2g9-5419-gs34-8h1jx4s733q9"
},
"recordId": {
"type": "string",
"example": "17fe582d-e1e0-4000-bf65-3d2ec2c500a4",
"description": "Record ID of the new created record"
},
"remainingCredits": {
"type": "number",
"example": 50
}
}
}
UserModel
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"displayName": {
"type": "string"
}
}
}
WebhooksCreateNew400Response
{
"oneOf": [
{
"$ref": "#/components/schemas/webhookInvalidEventTypeBadRequestResponse"
},
{
"$ref": "#/components/schemas/webhookTargetURLExistsBadRequestResponse"
}
]
}
WebhooksCreateNewRequest
{
"type": "object",
"required": [
"events",
"targetURL"
],
"properties": {
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/webhookEventTypeValue"
},
"minItems": 1,
"description": "The event type(s) to trigger the webhook. Note: you can use `*` to receive events for all events, although we don't recommend this path, especially for environments with higher volume."
},
"targetURL": {
"type": "string",
"description": "The URL to send the webhook event payload to."
}
}
}
WebhooksCreateNewResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "5928719b30182d3700364a74"
},
"events": {
"type": "array",
"items": {
"type": "string",
"example": "workflow_launched"
}
},
"company": {
"type": "string",
"example": "5928719b30182d3700364a74"
},
"targetURL": {
"type": "string",
"example": "https://requestb.in/18m34b"
}
}
}
WebhooksDeleteSpecific400Response
{
"type": "object",
"properties": {}
}
WebhooksDeleteSpecificResponse
{
"type": "object",
"properties": {}
}
WebhooksGetData400Response
{
"type": "object",
"properties": {}
}
WebhooksGetDataResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "5928719b30182d3700364a74"
},
"events": {
"type": "array",
"items": {
"type": "string",
"example": "workflow_launched"
}
},
"company": {
"type": "string",
"example": "5928719b30182d3700364a74"
},
"targetURL": {
"type": "string",
"example": "https://requestb.in/18m34b"
}
}
}
WebhooksGetVerificationKeyResponse
{
"type": "object",
"properties": {}
}
WebhooksListAll400Response
{
"type": "object",
"properties": {}
}
WebhooksListAllResponse
{
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "5928719b30182d3700364a74"
},
"events": {
"type": "array",
"items": {
"type": "string",
"example": "workflow_launched"
}
},
"company": {
"type": "string",
"example": "5928719b30182d3700364a74"
},
"targetURL": {
"type": "string",
"example": "https://requestb.in/18m34bs1"
}
}
}
},
"page": {
"type": "integer",
"default": 0,
"example": 0
},
"pageSize": {
"type": "integer",
"default": 0,
"example": 20
}
}
}
WebhooksUpdateWebhookData400Response
{
"type": "object",
"properties": {}
}
WebhooksUpdateWebhookDataRequest
{
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"type": "string"
},
"description": "The type of events that will trigger a notification to the target URL."
},
"targetURL": {
"type": "string",
"description": "The URL of where the notification gets sent."
}
}
}
WebhooksUpdateWebhookDataResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "5928719b30182d3700364a74"
},
"events": {
"type": "array",
"items": {
"type": "string",
"example": "workflow_launched"
}
},
"company": {
"type": "string",
"example": "5928719b30182d3700364a74"
},
"targetURL": {
"type": "string",
"example": "https://requestb.in/18m34b"
}
}
}
WorkflowAsyncInProgressResponse
{
"type": "object",
"title": "Workflow Launch In Progress",
"readOnly": true,
"required": [
"status",
"requestPayload"
],
"properties": {
"status": {
"type": "string",
"title": "",
"default": "in_progress",
"readOnly": true,
"description": ""
},
"requestPayload": {
"$ref": "#/components/schemas/WorkflowRequestModel"
}
},
"description": ""
}
WorkflowAsyncLaunchFailedResponse
{
"type": "object",
"title": "Workflow Launch Failed",
"readOnly": true,
"required": [
"status",
"requestPayload",
"error"
],
"properties": {
"error": {
"type": "string",
"title": "",
"readOnly": true,
"description": "An error message indicating why the workflow failed to launch."
},
"status": {
"type": "string",
"title": "",
"default": "failed",
"readOnly": true,
"description": ""
},
"requestPayload": {
"$ref": "#/components/schemas/WorkflowRequestModel"
}
},
"description": ""
}
WorkflowAsyncLaunchSuccessResponse
{
"type": "object",
"readOnly": true,
"required": [
"status",
"requestPayload",
"workflowUrls",
"workflow"
],
"properties": {
"status": {
"type": "string",
"title": "",
"default": "success",
"readOnly": true,
"description": ""
},
"workflow": {
"$ref": "#/components/schemas/LaunchedWorkflowModel"
},
"workflowUrls": {
"type": "object",
"title": "",
"readOnly": true,
"properties": {
"apiUrl": {
"type": "string",
"title": "",
"example": "http://ironcladapp.com/public/api/v1/workflows/6013609108b8f070cee94fc1",
"readOnly": true,
"description": "The URL for accessing workflow data via the REST API."
},
"browserUrl": {
"type": "string",
"title": "",
"example": "http://ironcladapp.com/workflows/6013609108b8f070cee94fc1",
"readOnly": true,
"description": "The URL for accessing the workflow in a browser."
}
},
"description": ""
},
"requestPayload": {
"$ref": "#/components/schemas/WorkflowRequestModel"
}
},
"description": "Response for a successfully asynchronously launched workflow."
}
WorkflowLastModifiedAuthorModel
{
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/InternalUserModel"
},
{
"$ref": "#/components/schemas/ExternalUserModel"
},
{
"type": "object",
"required": [
"type",
"displayName"
],
"properties": {
"type": {
"enum": [
"counterparty"
],
"type": "string",
"example": "counterparty"
},
"displayName": {
"type": "string",
"example": "Boba Fett"
}
}
}
],
"title": "author"
}
WorkflowNotFound
{
"type": "object",
"title": "Bad Request Error - Workflow ID Not Found",
"properties": {
"code": {
"type": "string",
"example": "NOT_FOUND"
},
"param": {
"type": "string",
"example": "workflowId"
},
"message": {
"type": "string",
"example": "workflow does not exist"
}
},
"description": "Workflow ID Not Found Request Error"
}
WorkflowRequestModel
{
"type": "object",
"required": [
"attributes",
"creator",
"template"
],
"properties": {
"creator": {
"$ref": "#/components/schemas/CreatorEmailModel"
},
"template": {
"$ref": "#/components/schemas/WorkflowTemplateIdModel"
},
"attributes": {
"$ref": "#/components/schemas/AttributesModel"
}
}
}
WorkflowResponseModel
{
"type": "object",
"required": [
"id",
"title",
"template",
"step",
"attributes",
"schema",
"isCancelled",
"isComplete",
"status",
"created",
"lastUpdated",
"roles",
"approvals",
"signatures",
"isRevertibleToReview"
],
"properties": {
"id": {
"type": "string",
"example": "6013609108b8f070cee94fc1"
},
"step": {
"type": "string",
"example": "Review"
},
"roles": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"displayName",
"assignees"
],
"properties": {
"id": {
"type": "string",
"example": "legal"
},
"assignees": {
"type": "array",
"items": {
"type": "object",
"required": [
"userName",
"userId",
"email"
],
"properties": {
"email": {
"type": "string",
"example": "bobafett@gmail.com"
},
"userId": {
"type": "string",
"example": "63d415e0dd0d828c3a878548"
},
"userName": {
"type": "string",
"example": "Boba Fett"
}
}
}
},
"displayName": {
"type": "string",
"example": "Legal"
}
}
}
},
"title": {
"type": "string",
"example": "Consulting Agreement with Jane Doe"
},
"schema": {
"type": "object",
"properties": {
"fee": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "monetaryAmount"
},
"displayName": {
"type": "string",
"example": "Example Monetary Amount Attribute"
}
}
},
"draft": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "array"
},
"elementType": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "document"
},
"displayName": {
"type": "string",
"example": "Example Document Attribute"
}
}
}
}
},
"amount": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "number"
},
"displayName": {
"type": "string",
"example": "Example Number Attribute"
}
}
},
"lineItems": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "array"
},
"elementType": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "object"
},
"schema": {
"type": "object",
"properties": {
"childAttribute": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
},
"displayName": {
"type": "string",
"example": "Example String Attribute"
}
}
},
"anotherChildAttribute": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
},
"displayName": {
"type": "string",
"example": "Example String Attribute"
}
}
}
}
},
"displayName": {
"type": "string",
"example": "Example Object Attribute"
}
}
}
}
},
"counterpartyName": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "string"
},
"displayName": {
"type": "string",
"example": "Example String Attribute"
}
}
}
}
},
"status": {
"enum": [
"active",
"completed",
"cancelled",
"paused"
],
"type": "string",
"example": "active"
},
"created": {
"type": "string",
"example": "2016-11-17T00:37:22.318Z"
},
"creator": {
"type": "object",
"required": [
"id",
"displayName",
"email",
"title",
"username",
"metadata"
],
"properties": {
"id": {
"type": "string",
"example": "63d415e0dd0d828c3a878548"
},
"email": {
"type": "string",
"example": "fett@intergalactic.com"
},
"title": {
"type": "string",
"example": "Director"
},
"metadata": {
"type": "object",
"example": {}
},
"username": {
"type": "string",
"example": "fett@intergalactic.com"
},
"displayName": {
"type": "string",
"example": "Boba Fett"
}
}
},
"template": {
"type": "string",
"example": "600b296c3e15a234ab88f884"
},
"approvals": {
"$ref": "#/components/schemas/WorkflowStateModel"
},
"recordIds": {
"type": "array",
"items": {
"type": "string",
"example": "715f1e37-292f-4e6c-8b48-c07e1b68bccd"
}
},
"attributes": {
"type": "object",
"properties": {
"fee": {
"type": "object",
"properties": {
"amount": {
"type": "integer",
"default": 0,
"example": 50000
},
"currency": {
"type": "string",
"example": "USD"
}
}
},
"draft": {
"type": "array",
"items": {
"type": "object",
"properties": {
"version": {
"type": "string",
"example": "B1QePArXb"
},
"download": {
"type": "string",
"example": "/public/api/v1/workflows/594356b9fbcd7f74006fdf8a/document/rJklwCHQ/download"
},
"filename": {
"type": "string",
"example": "file.pdf"
},
"lastModified": {
"type": "object",
"properties": {
"author": {
"$ref": "#/components/schemas/WorkflowLastModifiedAuthorModel"
},
"timestamp": {
"type": "string",
"example": "2016-11-17T00:37:22.318Z"
}
}
},
"versionNumber": {
"type": "number",
"example": 2
}
}
}
},
"amount": {
"type": "integer",
"default": 0,
"example": 123
},
"counterpartyName": {
"type": "string",
"example": "Boba Fett"
}
}
},
"ironcladId": {
"type": "string",
"example": "IC-1"
},
"isComplete": {
"type": "boolean",
"default": true,
"example": false
},
"signatures": {
"$ref": "#/components/schemas/WorkflowStateModel"
},
"isCancelled": {
"type": "boolean",
"default": true,
"example": false
},
"lastUpdated": {
"type": "string",
"example": "2016-11-17T00:37:22.318Z"
},
"isRevertibleToReview": {
"type": "boolean",
"example": false
}
},
"description": "The response from a successful workflow retrieval."
}
WorkflowRoleAssigneeModel
{
"type": "object",
"properties": {
"email": {
"type": "string",
"example": "bobafett@gmail.com"
},
"userId": {
"type": "string",
"example": "63d415e0dd0d828c3a878548"
},
"userName": {
"type": "string",
"example": "Boba Fett"
}
},
"description": ""
}
WorkflowRoleModel
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "legal"
},
"assignees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowRoleAssigneeModel"
}
},
"displayName": {
"type": "string",
"example": "Legal"
}
},
"description": ""
}
WorkflowStateModel
{
"type": "object",
"oneOf": [
{
"required": [
"state"
],
"properties": {
"state": {
"enum": [
"not_started"
],
"type": "string",
"example": "not_started"
}
}
},
{
"required": [
"state"
],
"properties": {
"state": {
"enum": [
"completed"
],
"type": "string",
"example": "completed"
}
}
},
{
"required": [
"state",
"url"
],
"properties": {
"url": {
"type": "string",
"example": "https://ironcladapp.com/public/api/v1/workflows/22e2ff72-56a1-4711-a4ca-41328d311e9f/approvals"
},
"state": {
"enum": [
"in_progress"
],
"type": "string",
"example": "in_progress"
}
}
},
{
"required": [
"state",
"message"
],
"properties": {
"state": {
"enum": [
"not_applicable"
],
"type": "string",
"example": "not_applicable"
},
"message": {
"type": "string",
"example": "This workflow has been cancelled"
}
}
}
]
}
WorkflowTemplateIdModel
{
"type": "string",
"example": "600b296c3e15a234ab88f884",
"description": "The identifier of the workflow template"
}
WorkflowsCreateComment400Response
{
"type": "object",
"properties": {}
}
WorkflowsCreateCommentRequest
{
"type": "object",
"required": [
"creator",
"comment"
],
"properties": {
"comment": {
"type": "string",
"description": "The comment text to add, accepts user mentions in the form of <@user_id_or_email>."
},
"creator": {
"$ref": "#/components/schemas/CreatorEmailModel"
},
"addUsersToWorkflow": {
"type": "boolean",
"description": "Must be set to true if mentioning users who are not participants on the workflow."
},
"repliedToActivityFeedMessageId": {
"type": "string",
"description": "Use to specify the comment to reply to"
}
}
}
WorkflowsCreateCommentRequest1
{
"type": "object",
"required": [
"creator",
"comment"
],
"properties": {
"comment": {
"type": "string",
"description": "The comment text to add, accepts user mentions in the form of <@user_id_or_email>."
},
"creator": {
"$ref": "#/components/schemas/CreatorEmailModel"
},
"addUsersToWorkflow": {
"type": "boolean",
"description": "Must be set to true if mentioning users who are not participants on the workflow."
},
"repliedToActivityFeedMessageId": {
"type": "string",
"description": "Use to specify the comment to reply to"
}
}
}
WorkflowsCreateCommentResponse
{
"type": "object",
"properties": {}
}
WorkflowsGetApprovalRequests403Response
{
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "FORBIDDEN"
},
"message": {
"type": "string",
"example": "access forbidden"
}
}
}
WorkflowsGetApprovalRequests404Response
{
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "NOT_FOUND"
},
"param": {
"type": "string",
"example": "workflowId"
},
"message": {
"type": "string",
"example": "workflow does not exist"
}
}
}
WorkflowsGetApprovalRequestsResponse
{
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"example": "approver58348a760b354ab3a986f56a74656c86"
},
"status": {
"type": "string",
"example": "approved"
},
"actorId": {
"type": "string",
"example": "6334b636b9fb1eb6e76ada97"
},
"endTime": {
"type": "string",
"example": "2022-09-28T19:21:05.034Z"
},
"roleName": {
"type": "string",
"example": "CEO"
},
"actorType": {
"type": "string",
"example": "User"
},
"startTime": {
"type": "string",
"example": "2022-09-20T15:51:54.156Z"
},
"actorDetails": {
"type": "object",
"example": {
"userName": {
"type": "string",
"example": "Cave Johnson"
},
"userEmail": {
"type": "string",
"example": "cave@aperturescience.com"
}
}
},
"approvalType": {
"type": "string",
"example": "Workflow"
}
}
}
},
"page": {
"type": "integer",
"default": 0,
"example": 0
},
"count": {
"type": "integer",
"example": 42
},
"pageSize": {
"type": "integer",
"default": 20,
"example": 20
}
}
}