Rightslineconnector v1

Version 1

Connector Overview: This page documents all 407 actions for the Rightslineconnector v1.

Allocation

GET /v4/allocation-model-list

/v4/allocation-model-list

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Amount (29)

POST /v4/amount

/v4/amount

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

GET /v4/amount-processes

/v4/amount-processes

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/amount-statuses/{templateId}

/v4/amount-statuses/{templateId}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Templateid

N/A

Response Type

N/A

GET /v4/amount-templates

/v4/amount-templates

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/amount-templates/{id}

/v4/amount-templates/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/amount-templates/{id}/{tagLabel}

/v4/amount-templates/{id}/{tagLabel}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Taglabel

N/A

Response Type

N/A

POST /v4/amount/data-default

/v4/amount/data-default

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (7)

Option Name

Description

Id

N/A

Recordids

N/A

Setchartypeid

N/A

Label

N/A

Relchartypeid

N/A

Relchildchartypeid

N/A

Copytitles

N/A

DELETE /v4/amount/data-default/{setGuid}

/v4/amount/data-default/{setGuid}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Setguid

N/A

Response Type

N/A

POST /v4/amount/search

/v4/amount/search

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Extendeddata

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/amount/search-count

/v4/amount/search-count

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/amount/search-deleted

/v4/amount/search-deleted

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (16)

Option Name

Description

Chartype

N/A

Recordid

N/A

Startdate

N/A

Enddate

N/A

Deletedbyid

N/A

Templateid

N/A

Statusid

N/A

Createdstartdate

N/A

Createdenddate

N/A

Createdbyid

N/A

Updatedstartdate

N/A

Updatedenddate

N/A

Updatedbyid

N/A

Statusupdatedstartdate

N/A

Statusupdatedenddate

N/A

Statusupdatedbyid

N/A

DELETE /v4/amount/{id}

/v4/amount/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Response Type

N/A

GET /v4/amount/{id}

/v4/amount/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Extendeddata

N/A

Response Type

N/A

PUT /v4/amount/{id}

/v4/amount/{id}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Extendeddata

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

GET /v4/amount/{id}/audit-history

/v4/amount/{id}/audit-history

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Userid

N/A

Page

N/A

Rows

N/A

Startdate

N/A

Enddate

N/A

Chartypeids

N/A

Showworkflow

N/A

Id

N/A

Response Type

N/A

GET /v4/amount/{id}/audit-history-detail

/v4/amount/{id}/audit-history-detail

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Isheader

N/A

Auditid

N/A

Sequence

N/A

Operationid

N/A

Includemessages

N/A

Id

N/A

Response Type

N/A

GET /v4/amount/{id}/copy-warnings

/v4/amount/{id}/copy-warnings

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Templateid

N/A

Response Type

N/A

GET /v4/amount/{id}/data-default

/v4/amount/{id}/data-default

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

POST /v4/amount/{id}/data-default

/v4/amount/{id}/data-default

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (7)

Option Name

Description

Id

N/A

Recordids

N/A

Setchartypeid

N/A

Label

N/A

Relchartypeid

N/A

Relchildchartypeid

N/A

Copytitles

N/A

GET /v4/amount/{id}/date-alerts

/v4/amount/{id}/date-alerts

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/amount/{id}/date-math

/v4/amount/{id}/date-math

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/amount/{id}/draft-templates

/v4/amount/{id}/draft-templates

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

PUT /v4/amount/{id}/execute-document-workflow-action/{actionID}

/v4/amount/{id}/execute-document-workflow-action/{actionID}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

Options (1)

Option Name

Description

Templateid

N/A

PUT /v4/amount/{id}/execute-signature-workflow-action/{actionID}

/v4/amount/{id}/execute-signature-workflow-action/{actionID}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

Options (6)

Option Name

Description

Documentid

N/A

Emails

N/A

Cc

N/A

Enforcesignorder

N/A

Expireafterdays

N/A

Warnbeforeexpiredays

N/A

PUT /v4/amount/{id}/execute-workflow-action/{actionID}

/v4/amount/{id}/execute-workflow-action/{actionID}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

GET /v4/amount/{id}/get-lov-friendly-string/{tagLabel}

/v4/amount/{id}/get-lov-friendly-string/{tagLabel}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Taglabel

N/A

Response Type

N/A

POST /v4/amount/{id}/switch-template

/v4/amount/{id}/switch-template

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (14)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

Chartypeid

N/A

Copyrelationships

N/A

Newtemplateid

N/A

Copyparties

N/A

POST /v4/amount/{id}/switch-template-check

/v4/amount/{id}/switch-template-check

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (14)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

Chartypeid

N/A

Copyrelationships

N/A

Newtemplateid

N/A

Copyparties

N/A

GET /v4/amount/{id}/validation-errors

/v4/amount/{id}/validation-errors

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Auth

POST /v4/auth/temporary-credentials

/v4/auth/temporary-credentials

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (2)

Option Name

Description

Accesskey

N/A

Secretkey

N/A

Avails (7)

GET /v4/avails/availability

/v4/avails/availability

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (25)

Option Name

Description

Dim1

N/A

Dim2

N/A

Dim3

N/A

Dim4

N/A

Windowstart

N/A

Windowend

N/A

Isexclusive

N/A

Matchtype

N/A

Start

N/A

Rows

N/A

Includeuserfriendlydimensiondisplay

N/A

Isexact

N/A

Iswindowingenforced

N/A

Showunavailable

N/A

Templateids

N/A

Righttemplateids

N/A

Statusids

N/A

Includeassociateddealids

N/A

Truncatedatestosearch

N/A

Includerecalcstatus

N/A

Minwindowdays

N/A

Rollupdimid

N/A

Scopedimensions

N/A

Scopeexclusivity

N/A

Recordid

N/A

POST /v4/avails/availability

/v4/avails/availability

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (25)

Option Name

Description

Dim1

N/A

Dim2

N/A

Dim3

N/A

Dim4

N/A

Windowstart

N/A

Windowend

N/A

Isexclusive

N/A

Matchtype

N/A

Start

N/A

Rows

N/A

Includeuserfriendlydimensiondisplay

N/A

Isexact

N/A

Iswindowingenforced

N/A

Showunavailable

N/A

Templateids

N/A

Righttemplateids

N/A

Statusids

N/A

Includeassociateddealids

N/A

Truncatedatestosearch

N/A

Includerecalcstatus

N/A

Minwindowdays

N/A

Rollupdimid

N/A

Scopedimensions

N/A

Scopeexclusivity

N/A

Recordid

N/A

POST /v4/avails/available-catalog-items

/v4/avails/available-catalog-items

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (24)

Option Name

Description

Dim1

N/A

Dim2

N/A

Dim3

N/A

Dim4

N/A

Windowstart

N/A

Windowend

N/A

Isexclusive

N/A

Matchtype

N/A

Start

N/A

Rows

N/A

Includeuserfriendlydimensiondisplay

N/A

Isexact

N/A

Iswindowingenforced

N/A

Showunavailable

N/A

Templateids

N/A

Righttemplateids

N/A

Statusids

N/A

Includeassociateddealids

N/A

Truncatedatestosearch

N/A

Includerecalcstatus

N/A

Minwindowdays

N/A

Rollupdimid

N/A

Scopedimensions

N/A

Scopeexclusivity

N/A

GET /v4/avails/dimension-data

/v4/avails/dimension-data

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

POST /v4/avails/is-title-available

/v4/avails/is-title-available

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (13)

Option Name

Description

Dim1

N/A

Dim2

N/A

Dim3

N/A

Dim4

N/A

Windowstart

N/A

Windowend

N/A

Isexclusive

N/A

Matchtype

N/A

Start

N/A

Rows

N/A

Includeuserfriendlydimensiondisplay

N/A

Recordid

N/A

Includerecalcstatus

N/A

GET /v4/avails/reason-unavailable-list

/v4/avails/reason-unavailable-list

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/avails/recalc-status/{id}

/v4/avails/recalc-status/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Batch (2)

POST /v4/batch

/v4/batch

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (2)

Option Name

Description

Method

N/A

Amortizationmodelid

N/A

GET /v4/batch/{batchId}

/v4/batch/{batchId}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Batchid

N/A

Extendeddata

N/A

Response Type

N/A

Catalog-item (36)

POST /v4/catalog-item

/v4/catalog-item

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

GET /v4/catalog-item-processes

/v4/catalog-item-processes

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/catalog-item-statuses/{templateId}

/v4/catalog-item-statuses/{templateId}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Templateid

N/A

Response Type

N/A

GET /v4/catalog-item-templates

/v4/catalog-item-templates

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/catalog-item-templates/{id}

/v4/catalog-item-templates/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/catalog-item-templates/{id}/{tagLabel}

/v4/catalog-item-templates/{id}/{tagLabel}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Taglabel

N/A

Response Type

N/A

POST /v4/catalog-item/data-default

/v4/catalog-item/data-default

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (7)

Option Name

Description

Id

N/A

Recordids

N/A

Setchartypeid

N/A

Label

N/A

Relchartypeid

N/A

Relchildchartypeid

N/A

Copytitles

N/A

DELETE /v4/catalog-item/data-default/{setGuid}

/v4/catalog-item/data-default/{setGuid}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Setguid

N/A

Response Type

N/A

POST /v4/catalog-item/search

/v4/catalog-item/search

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Extendeddata

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/catalog-item/search-count

/v4/catalog-item/search-count

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/catalog-item/search-deleted

/v4/catalog-item/search-deleted

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (16)

Option Name

Description

Chartype

N/A

Recordid

N/A

Startdate

N/A

Enddate

N/A

Deletedbyid

N/A

Templateid

N/A

Statusid

N/A

Createdstartdate

N/A

Createdenddate

N/A

Createdbyid

N/A

Updatedstartdate

N/A

Updatedenddate

N/A

Updatedbyid

N/A

Statusupdatedstartdate

N/A

Statusupdatedenddate

N/A

Statusupdatedbyid

N/A

DELETE /v4/catalog-item/{id}

/v4/catalog-item/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Response Type

N/A

GET /v4/catalog-item/{id}

/v4/catalog-item/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Extendeddata

N/A

Response Type

N/A

PUT /v4/catalog-item/{id}

/v4/catalog-item/{id}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Extendeddata

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

GET /v4/catalog-item/{id}/audit-history

/v4/catalog-item/{id}/audit-history

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Userid

N/A

Page

N/A

Rows

N/A

Startdate

N/A

Enddate

N/A

Chartypeids

N/A

Showworkflow

N/A

Id

N/A

Response Type

N/A

GET /v4/catalog-item/{id}/audit-history-detail

/v4/catalog-item/{id}/audit-history-detail

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Isheader

N/A

Auditid

N/A

Sequence

N/A

Operationid

N/A

Includemessages

N/A

Id

N/A

Response Type

N/A

GET /v4/catalog-item/{id}/copy-warnings

/v4/catalog-item/{id}/copy-warnings

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Templateid

N/A

Response Type

N/A

GET /v4/catalog-item/{id}/data-default

/v4/catalog-item/{id}/data-default

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

POST /v4/catalog-item/{id}/data-default

/v4/catalog-item/{id}/data-default

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (7)

Option Name

Description

Id

N/A

Recordids

N/A

Setchartypeid

N/A

Label

N/A

Relchartypeid

N/A

Relchildchartypeid

N/A

Copytitles

N/A

GET /v4/catalog-item/{id}/date-alerts

/v4/catalog-item/{id}/date-alerts

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/catalog-item/{id}/date-math

/v4/catalog-item/{id}/date-math

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/catalog-item/{id}/delete-check

/v4/catalog-item/{id}/delete-check

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Skip

N/A

Rows

N/A

Response Type

N/A

GET /v4/catalog-item/{id}/draft-templates

/v4/catalog-item/{id}/draft-templates

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

PUT /v4/catalog-item/{id}/execute-document-workflow-action/{actionID}

/v4/catalog-item/{id}/execute-document-workflow-action/{actionID}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

Options (1)

Option Name

Description

Templateid

N/A

PUT /v4/catalog-item/{id}/execute-signature-workflow-action/{actionID}

/v4/catalog-item/{id}/execute-signature-workflow-action/{actionID}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

Options (6)

Option Name

Description

Documentid

N/A

Emails

N/A

Cc

N/A

Enforcesignorder

N/A

Expireafterdays

N/A

Warnbeforeexpiredays

N/A

PUT /v4/catalog-item/{id}/execute-workflow-action/{actionID}

/v4/catalog-item/{id}/execute-workflow-action/{actionID}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

GET /v4/catalog-item/{id}/get-lov-friendly-string/{tagLabel}

/v4/catalog-item/{id}/get-lov-friendly-string/{tagLabel}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Taglabel

N/A

Response Type

N/A

DELETE /v4/catalog-item/{id}/keyart

/v4/catalog-item/{id}/keyart

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/catalog-item/{id}/keyart

/v4/catalog-item/{id}/keyart

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

PUT /v4/catalog-item/{id}/keyart

/v4/catalog-item/{id}/keyart

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (2)

Option Name

Description

Label

N/A

Filename

N/A

GET /v4/catalog-item/{id}/keyart/url

/v4/catalog-item/{id}/keyart/url

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

PUT /v4/catalog-item/{id}/overwrite-parties

/v4/catalog-item/{id}/overwrite-parties

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (1)

Option Name

Description

Selectedparties

N/A

GET /v4/catalog-item/{id}/rights-in-hierarchy

/v4/catalog-item/{id}/rights-in-hierarchy

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Start

N/A

Rows

N/A

Response Type

N/A

POST /v4/catalog-item/{id}/switch-template

/v4/catalog-item/{id}/switch-template

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (14)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

Chartypeid

N/A

Copyrelationships

N/A

Newtemplateid

N/A

Copyparties

N/A

POST /v4/catalog-item/{id}/switch-template-check

/v4/catalog-item/{id}/switch-template-check

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (14)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

Chartypeid

N/A

Copyrelationships

N/A

Newtemplateid

N/A

Copyparties

N/A

GET /v4/catalog-item/{id}/validation-errors

/v4/catalog-item/{id}/validation-errors

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Contact (26)

POST /v4/contact

/v4/contact

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

GET /v4/contact-processes

/v4/contact-processes

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/contact-statuses/{templateId}

/v4/contact-statuses/{templateId}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Templateid

N/A

Response Type

N/A

GET /v4/contact-templates

/v4/contact-templates

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/contact-templates/{id}

/v4/contact-templates/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/contact-templates/{id}/{tagLabel}

/v4/contact-templates/{id}/{tagLabel}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Taglabel

N/A

Response Type

N/A

POST /v4/contact/search

/v4/contact/search

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Extendeddata

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/contact/search-count

/v4/contact/search-count

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/contact/search-deleted

/v4/contact/search-deleted

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (16)

Option Name

Description

Chartype

N/A

Recordid

N/A

Startdate

N/A

Enddate

N/A

Deletedbyid

N/A

Templateid

N/A

Statusid

N/A

Createdstartdate

N/A

Createdenddate

N/A

Createdbyid

N/A

Updatedstartdate

N/A

Updatedenddate

N/A

Updatedbyid

N/A

Statusupdatedstartdate

N/A

Statusupdatedenddate

N/A

Statusupdatedbyid

N/A

DELETE /v4/contact/{id}

/v4/contact/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Response Type

N/A

GET /v4/contact/{id}

/v4/contact/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Extendeddata

N/A

Response Type

N/A

PUT /v4/contact/{id}

/v4/contact/{id}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Extendeddata

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

GET /v4/contact/{id}/audit-history

/v4/contact/{id}/audit-history

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Userid

N/A

Page

N/A

Rows

N/A

Startdate

N/A

Enddate

N/A

Chartypeids

N/A

Showworkflow

N/A

Id

N/A

Response Type

N/A

GET /v4/contact/{id}/audit-history-detail

/v4/contact/{id}/audit-history-detail

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Isheader

N/A

Auditid

N/A

Sequence

N/A

Operationid

N/A

Includemessages

N/A

Id

N/A

Response Type

N/A

GET /v4/contact/{id}/copy-warnings

/v4/contact/{id}/copy-warnings

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Templateid

N/A

Response Type

N/A

GET /v4/contact/{id}/date-alerts

/v4/contact/{id}/date-alerts

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/contact/{id}/date-math

/v4/contact/{id}/date-math

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/contact/{id}/delete-check

/v4/contact/{id}/delete-check

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Skip

N/A

Rows

N/A

Response Type

N/A

GET /v4/contact/{id}/draft-templates

/v4/contact/{id}/draft-templates

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

PUT /v4/contact/{id}/execute-document-workflow-action/{actionID}

/v4/contact/{id}/execute-document-workflow-action/{actionID}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

Options (1)

Option Name

Description

Templateid

N/A

PUT /v4/contact/{id}/execute-signature-workflow-action/{actionID}

/v4/contact/{id}/execute-signature-workflow-action/{actionID}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

Options (6)

Option Name

Description

Documentid

N/A

Emails

N/A

Cc

N/A

Enforcesignorder

N/A

Expireafterdays

N/A

Warnbeforeexpiredays

N/A

PUT /v4/contact/{id}/execute-workflow-action/{actionID}

/v4/contact/{id}/execute-workflow-action/{actionID}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

GET /v4/contact/{id}/get-lov-friendly-string/{tagLabel}

/v4/contact/{id}/get-lov-friendly-string/{tagLabel}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Taglabel

N/A

Response Type

N/A

POST /v4/contact/{id}/switch-template

/v4/contact/{id}/switch-template

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (14)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

Chartypeid

N/A

Copyrelationships

N/A

Newtemplateid

N/A

Copyparties

N/A

POST /v4/contact/{id}/switch-template-check

/v4/contact/{id}/switch-template-check

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (14)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

Chartypeid

N/A

Copyrelationships

N/A

Newtemplateid

N/A

Copyparties

N/A

GET /v4/contact/{id}/validation-errors

/v4/contact/{id}/validation-errors

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Currency (5)

POST /v4/currency/conversion

/v4/currency/conversion

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Externalid

N/A

Currencyconversionid

N/A

Companycurrency

N/A

Transactioncurrency

N/A

Groupcurrency

N/A

Rate

N/A

Effectivedate

N/A

Conversiontype

N/A

Usenewcurrencyconfig

N/A

GET /v4/currency/conversion/list

/v4/currency/conversion/list

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

DELETE /v4/currency/conversion/{id}

/v4/currency/conversion/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/currency/conversion/{id}

/v4/currency/conversion/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

PUT /v4/currency/conversion/{id}

/v4/currency/conversion/{id}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Externalid

N/A

Currencyconversionid

N/A

Companycurrency

N/A

Transactioncurrency

N/A

Groupcurrency

N/A

Rate

N/A

Effectivedate

N/A

Conversiontype

N/A

Usenewcurrencyconfig

N/A

Date-math (3)

POST /v4/date-math

/v4/date-math

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

PUT /v4/date-math

/v4/date-math

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

DELETE /v4/date-math/{dateMathCalcId}

/v4/date-math/{dateMathCalcId}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Datemathcalcid

N/A

Response Type

N/A

Deal (34)

POST /v4/deal

/v4/deal

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

GET /v4/deal-processes

/v4/deal-processes

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/deal-statuses/{templateId}

/v4/deal-statuses/{templateId}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Templateid

N/A

Response Type

N/A

GET /v4/deal-templates

/v4/deal-templates

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/deal-templates/{id}

/v4/deal-templates/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/deal-templates/{id}/{tagLabel}

/v4/deal-templates/{id}/{tagLabel}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Taglabel

N/A

Response Type

N/A

POST /v4/deal/data-default

/v4/deal/data-default

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (7)

Option Name

Description

Id

N/A

Recordids

N/A

Setchartypeid

N/A

Label

N/A

Relchartypeid

N/A

Relchildchartypeid

N/A

Copytitles

N/A

DELETE /v4/deal/data-default/{setGuid}

/v4/deal/data-default/{setGuid}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Setguid

N/A

Response Type

N/A

POST /v4/deal/search

/v4/deal/search

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Extendeddata

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/deal/search-count

/v4/deal/search-count

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/deal/search-deleted

/v4/deal/search-deleted

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (16)

Option Name

Description

Chartype

N/A

Recordid

N/A

Startdate

N/A

Enddate

N/A

Deletedbyid

N/A

Templateid

N/A

Statusid

N/A

Createdstartdate

N/A

Createdenddate

N/A

Createdbyid

N/A

Updatedstartdate

N/A

Updatedenddate

N/A

Updatedbyid

N/A

Statusupdatedstartdate

N/A

Statusupdatedenddate

N/A

Statusupdatedbyid

N/A

DELETE /v4/deal/{id}

/v4/deal/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Response Type

N/A

GET /v4/deal/{id}

/v4/deal/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Extendeddata

N/A

Response Type

N/A

PUT /v4/deal/{id}

/v4/deal/{id}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Extendeddata

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

GET /v4/deal/{id}/audit-history

/v4/deal/{id}/audit-history

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Userid

N/A

Page

N/A

Rows

N/A

Startdate

N/A

Enddate

N/A

Chartypeids

N/A

Showworkflow

N/A

Id

N/A

Response Type

N/A

GET /v4/deal/{id}/audit-history-detail

/v4/deal/{id}/audit-history-detail

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Isheader

N/A

Auditid

N/A

Sequence

N/A

Operationid

N/A

Includemessages

N/A

Id

N/A

Response Type

N/A

POST /v4/deal/{id}/calculate-allocations

/v4/deal/{id}/calculate-allocations

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (4)

Option Name

Description

Rightsdimensionid

N/A

Catalogdistribution

N/A

Hierarchydistribution

N/A

Rolluptooneamount

N/A

GET /v4/deal/{id}/conflicts

/v4/deal/{id}/conflicts

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Start

N/A

Rows

N/A

Response Type

N/A

GET /v4/deal/{id}/conflicts/{conflictId}

/v4/deal/{id}/conflicts/{conflictId}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Conflictid

N/A

Response Type

N/A

PUT /v4/deal/{id}/conflicts/{conflictId}

/v4/deal/{id}/conflicts/{conflictId}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Conflictid

N/A

Response Type

N/A

Options (3)

Option Name

Description

Id

N/A

Isblocker

N/A

Reasonforchange

N/A

GET /v4/deal/{id}/copy-warnings

/v4/deal/{id}/copy-warnings

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Templateid

N/A

Response Type

N/A

GET /v4/deal/{id}/data-default

/v4/deal/{id}/data-default

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

POST /v4/deal/{id}/data-default

/v4/deal/{id}/data-default

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (7)

Option Name

Description

Id

N/A

Recordids

N/A

Setchartypeid

N/A

Label

N/A

Relchartypeid

N/A

Relchildchartypeid

N/A

Copytitles

N/A

GET /v4/deal/{id}/date-alerts

/v4/deal/{id}/date-alerts

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/deal/{id}/date-math

/v4/deal/{id}/date-math

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/deal/{id}/draft-templates

/v4/deal/{id}/draft-templates

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

PUT /v4/deal/{id}/execute-document-workflow-action/{actionID}

/v4/deal/{id}/execute-document-workflow-action/{actionID}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

Options (1)

Option Name

Description

Templateid

N/A

PUT /v4/deal/{id}/execute-signature-workflow-action/{actionID}

/v4/deal/{id}/execute-signature-workflow-action/{actionID}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

Options (6)

Option Name

Description

Documentid

N/A

Emails

N/A

Cc

N/A

Enforcesignorder

N/A

Expireafterdays

N/A

Warnbeforeexpiredays

N/A

PUT /v4/deal/{id}/execute-workflow-action/{actionID}

/v4/deal/{id}/execute-workflow-action/{actionID}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

GET /v4/deal/{id}/get-lov-friendly-string/{tagLabel}

/v4/deal/{id}/get-lov-friendly-string/{tagLabel}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Taglabel

N/A

Response Type

N/A

PUT /v4/deal/{id}/overwrite-parties

/v4/deal/{id}/overwrite-parties

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (1)

Option Name

Description

Selectedparties

N/A

POST /v4/deal/{id}/switch-template

/v4/deal/{id}/switch-template

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (14)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

Chartypeid

N/A

Copyrelationships

N/A

Newtemplateid

N/A

Copyparties

N/A

POST /v4/deal/{id}/switch-template-check

/v4/deal/{id}/switch-template-check

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (14)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

Chartypeid

N/A

Copyrelationships

N/A

Newtemplateid

N/A

Copyparties

N/A

GET /v4/deal/{id}/validation-errors

/v4/deal/{id}/validation-errors

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

File (31)

POST /v4/file

/v4/file

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

GET /v4/file-processes

/v4/file-processes

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/file-statuses/{templateId}

/v4/file-statuses/{templateId}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Templateid

N/A

Response Type

N/A

GET /v4/file-templates

/v4/file-templates

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/file-templates/{id}

/v4/file-templates/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/file-templates/{id}/{tagLabel}

/v4/file-templates/{id}/{tagLabel}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Taglabel

N/A

Response Type

N/A

POST /v4/file/search

/v4/file/search

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Extendeddata

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/file/search-count

/v4/file/search-count

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/file/search-deleted

/v4/file/search-deleted

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (16)

Option Name

Description

Chartype

N/A

Recordid

N/A

Startdate

N/A

Enddate

N/A

Deletedbyid

N/A

Templateid

N/A

Statusid

N/A

Createdstartdate

N/A

Createdenddate

N/A

Createdbyid

N/A

Updatedstartdate

N/A

Updatedenddate

N/A

Updatedbyid

N/A

Statusupdatedstartdate

N/A

Statusupdatedenddate

N/A

Statusupdatedbyid

N/A

DELETE /v4/file/{id}

/v4/file/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Response Type

N/A

GET /v4/file/{id}

/v4/file/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Extendeddata

N/A

Response Type

N/A

PUT /v4/file/{id}

/v4/file/{id}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

DELETE /v4/file/{id}-{revisionId}

/v4/file/{id}-{revisionId}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Response Type

N/A

GET /v4/file/{id}-{revisionId}

/v4/file/{id}-{revisionId}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Extendeddata

N/A

Response Type

N/A

GET /v4/file/{id}-{revisionId}/data

/v4/file/{id}-{revisionId}/data

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Response Type

N/A

GET /v4/file/{id}-{revisionId}/url

/v4/file/{id}-{revisionId}/url

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Response Type

N/A

GET /v4/file/{id}/audit-history

/v4/file/{id}/audit-history

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Userid

N/A

Page

N/A

Rows

N/A

Startdate

N/A

Enddate

N/A

Chartypeids

N/A

Showworkflow

N/A

Id

N/A

Response Type

N/A

GET /v4/file/{id}/audit-history-detail

/v4/file/{id}/audit-history-detail

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Isheader

N/A

Auditid

N/A

Sequence

N/A

Operationid

N/A

Includemessages

N/A

Id

N/A

Response Type

N/A

GET /v4/file/{id}/copy-warnings

/v4/file/{id}/copy-warnings

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Templateid

N/A

Response Type

N/A

GET /v4/file/{id}/data

/v4/file/{id}/data

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Response Type

N/A

GET /v4/file/{id}/date-alerts

/v4/file/{id}/date-alerts

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/file/{id}/draft-templates

/v4/file/{id}/draft-templates

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

PUT /v4/file/{id}/execute-document-workflow-action/{actionID}

/v4/file/{id}/execute-document-workflow-action/{actionID}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

Options (1)

Option Name

Description

Templateid

N/A

PUT /v4/file/{id}/execute-signature-workflow-action/{actionID}

/v4/file/{id}/execute-signature-workflow-action/{actionID}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

Options (6)

Option Name

Description

Documentid

N/A

Emails

N/A

Cc

N/A

Enforcesignorder

N/A

Expireafterdays

N/A

Warnbeforeexpiredays

N/A

PUT /v4/file/{id}/execute-workflow-action/{actionID}

/v4/file/{id}/execute-workflow-action/{actionID}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

GET /v4/file/{id}/get-lov-friendly-string/{tagLabel}

/v4/file/{id}/get-lov-friendly-string/{tagLabel}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Taglabel

N/A

Response Type

N/A

GET /v4/file/{id}/revisions

/v4/file/{id}/revisions

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

POST /v4/file/{id}/switch-template

/v4/file/{id}/switch-template

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (14)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

Chartypeid

N/A

Copyrelationships

N/A

Newtemplateid

N/A

Copyparties

N/A

POST /v4/file/{id}/switch-template-check

/v4/file/{id}/switch-template-check

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (14)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

Chartypeid

N/A

Copyrelationships

N/A

Newtemplateid

N/A

Copyparties

N/A

GET /v4/file/{id}/url

/v4/file/{id}/url

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Response Type

N/A

GET /v4/file/{id}/validation-errors

/v4/file/{id}/validation-errors

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Financial-document (25)

POST /v4/financial-document

/v4/financial-document

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

GET /v4/financial-document-processes

/v4/financial-document-processes

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/financial-document-statuses/{templateId}

/v4/financial-document-statuses/{templateId}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Templateid

N/A

Response Type

N/A

GET /v4/financial-document-templates

/v4/financial-document-templates

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/financial-document-templates/{id}

/v4/financial-document-templates/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/financial-document-templates/{id}/{tagLabel}

/v4/financial-document-templates/{id}/{tagLabel}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Taglabel

N/A

Response Type

N/A

POST /v4/financial-document/search

/v4/financial-document/search

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Extendeddata

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/financial-document/search-count

/v4/financial-document/search-count

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/financial-document/search-deleted

/v4/financial-document/search-deleted

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (16)

Option Name

Description

Chartype

N/A

Recordid

N/A

Startdate

N/A

Enddate

N/A

Deletedbyid

N/A

Templateid

N/A

Statusid

N/A

Createdstartdate

N/A

Createdenddate

N/A

Createdbyid

N/A

Updatedstartdate

N/A

Updatedenddate

N/A

Updatedbyid

N/A

Statusupdatedstartdate

N/A

Statusupdatedenddate

N/A

Statusupdatedbyid

N/A

DELETE /v4/financial-document/{id}

/v4/financial-document/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Response Type

N/A

GET /v4/financial-document/{id}

/v4/financial-document/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Extendeddata

N/A

Response Type

N/A

PUT /v4/financial-document/{id}

/v4/financial-document/{id}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Extendeddata

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

GET /v4/financial-document/{id}/audit-history

/v4/financial-document/{id}/audit-history

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Userid

N/A

Page

N/A

Rows

N/A

Startdate

N/A

Enddate

N/A

Chartypeids

N/A

Showworkflow

N/A

Id

N/A

Response Type

N/A

GET /v4/financial-document/{id}/audit-history-detail

/v4/financial-document/{id}/audit-history-detail

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Isheader

N/A

Auditid

N/A

Sequence

N/A

Operationid

N/A

Includemessages

N/A

Id

N/A

Response Type

N/A

GET /v4/financial-document/{id}/copy-warnings

/v4/financial-document/{id}/copy-warnings

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Templateid

N/A

Response Type

N/A

GET /v4/financial-document/{id}/date-alerts

/v4/financial-document/{id}/date-alerts

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/financial-document/{id}/draft-templates

/v4/financial-document/{id}/draft-templates

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

PUT /v4/financial-document/{id}/execute-document-workflow-action/{actionID}

/v4/financial-document/{id}/execute-document-workflow-action/{actionID}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

Options (1)

Option Name

Description

Templateid

N/A

PUT /v4/financial-document/{id}/execute-signature-workflow-action/{actionID}

/v4/financial-document/{id}/execute-signature-workflow-action/{actionID}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

Options (6)

Option Name

Description

Documentid

N/A

Emails

N/A

Cc

N/A

Enforcesignorder

N/A

Expireafterdays

N/A

Warnbeforeexpiredays

N/A

PUT /v4/financial-document/{id}/execute-workflow-action/{actionID}

/v4/financial-document/{id}/execute-workflow-action/{actionID}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

GET /v4/financial-document/{id}/get-lov-friendly-string/{tagLabel}

/v4/financial-document/{id}/get-lov-friendly-string/{tagLabel}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Taglabel

N/A

Response Type

N/A

PUT /v4/financial-document/{id}/overwrite-parties

/v4/financial-document/{id}/overwrite-parties

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (1)

Option Name

Description

Selectedparties

N/A

POST /v4/financial-document/{id}/switch-template

/v4/financial-document/{id}/switch-template

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (14)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

Chartypeid

N/A

Copyrelationships

N/A

Newtemplateid

N/A

Copyparties

N/A

POST /v4/financial-document/{id}/switch-template-check

/v4/financial-document/{id}/switch-template-check

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (14)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

Chartypeid

N/A

Copyrelationships

N/A

Newtemplateid

N/A

Copyparties

N/A

GET /v4/financial-document/{id}/validation-errors

/v4/financial-document/{id}/validation-errors

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Financial-periods (7)

GET /v4/financial-periods

/v4/financial-periods

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

POST /v4/financial-periods

/v4/financial-periods

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (5)

Option Name

Description

Id

N/A

Year

N/A

Period

N/A

Startdate

N/A

Enddate

N/A

GET /v4/financial-periods-settings

/v4/financial-periods-settings

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

PUT /v4/financial-periods-settings

/v4/financial-periods-settings

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (4)

Option Name

Description

Processname

N/A

Processid

N/A

Actionid

N/A

Actionname

N/A

DELETE /v4/financial-periods/{id}

/v4/financial-periods/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

PUT /v4/financial-periods/{id}

/v4/financial-periods/{id}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (5)

Option Name

Description

Id

N/A

Year

N/A

Period

N/A

Startdate

N/A

Enddate

N/A

PUT /v4/financial-periods/{id}/close

/v4/financial-periods/{id}/close

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Inventory (34)

POST /v4/inventory

/v4/inventory

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

GET /v4/inventory-processes

/v4/inventory-processes

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/inventory-statuses/{templateId}

/v4/inventory-statuses/{templateId}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Templateid

N/A

Response Type

N/A

GET /v4/inventory-templates

/v4/inventory-templates

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/inventory-templates/{id}

/v4/inventory-templates/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/inventory-templates/{id}/{tagLabel}

/v4/inventory-templates/{id}/{tagLabel}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Taglabel

N/A

Response Type

N/A

POST /v4/inventory/data-default

/v4/inventory/data-default

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (7)

Option Name

Description

Id

N/A

Recordids

N/A

Setchartypeid

N/A

Label

N/A

Relchartypeid

N/A

Relchildchartypeid

N/A

Copytitles

N/A

DELETE /v4/inventory/data-default/{setGuid}

/v4/inventory/data-default/{setGuid}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Setguid

N/A

Response Type

N/A

POST /v4/inventory/search

/v4/inventory/search

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Extendeddata

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/inventory/search-count

/v4/inventory/search-count

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/inventory/search-deleted

/v4/inventory/search-deleted

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (16)

Option Name

Description

Chartype

N/A

Recordid

N/A

Startdate

N/A

Enddate

N/A

Deletedbyid

N/A

Templateid

N/A

Statusid

N/A

Createdstartdate

N/A

Createdenddate

N/A

Createdbyid

N/A

Updatedstartdate

N/A

Updatedenddate

N/A

Updatedbyid

N/A

Statusupdatedstartdate

N/A

Statusupdatedenddate

N/A

Statusupdatedbyid

N/A

DELETE /v4/inventory/{id}

/v4/inventory/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Response Type

N/A

GET /v4/inventory/{id}

/v4/inventory/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Extendeddata

N/A

Response Type

N/A

PUT /v4/inventory/{id}

/v4/inventory/{id}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Extendeddata

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

GET /v4/inventory/{id}/audit-history

/v4/inventory/{id}/audit-history

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Userid

N/A

Page

N/A

Rows

N/A

Startdate

N/A

Enddate

N/A

Chartypeids

N/A

Showworkflow

N/A

Id

N/A

Response Type

N/A

GET /v4/inventory/{id}/audit-history-detail

/v4/inventory/{id}/audit-history-detail

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Isheader

N/A

Auditid

N/A

Sequence

N/A

Operationid

N/A

Includemessages

N/A

Id

N/A

Response Type

N/A

GET /v4/inventory/{id}/copy-warnings

/v4/inventory/{id}/copy-warnings

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Templateid

N/A

Response Type

N/A

GET /v4/inventory/{id}/data-default

/v4/inventory/{id}/data-default

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

POST /v4/inventory/{id}/data-default

/v4/inventory/{id}/data-default

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (7)

Option Name

Description

Id

N/A

Recordids

N/A

Setchartypeid

N/A

Label

N/A

Relchartypeid

N/A

Relchildchartypeid

N/A

Copytitles

N/A

GET /v4/inventory/{id}/date-alerts

/v4/inventory/{id}/date-alerts

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/inventory/{id}/date-math

/v4/inventory/{id}/date-math

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/inventory/{id}/draft-templates

/v4/inventory/{id}/draft-templates

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

PUT /v4/inventory/{id}/execute-document-workflow-action/{actionID}

/v4/inventory/{id}/execute-document-workflow-action/{actionID}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

Options (1)

Option Name

Description

Templateid

N/A

PUT /v4/inventory/{id}/execute-signature-workflow-action/{actionID}

/v4/inventory/{id}/execute-signature-workflow-action/{actionID}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

Options (6)

Option Name

Description

Documentid

N/A

Emails

N/A

Cc

N/A

Enforcesignorder

N/A

Expireafterdays

N/A

Warnbeforeexpiredays

N/A

PUT /v4/inventory/{id}/execute-workflow-action/{actionID}

/v4/inventory/{id}/execute-workflow-action/{actionID}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

GET /v4/inventory/{id}/get-lov-friendly-string/{tagLabel}

/v4/inventory/{id}/get-lov-friendly-string/{tagLabel}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Taglabel

N/A

Response Type

N/A

DELETE /v4/inventory/{id}/keyart

/v4/inventory/{id}/keyart

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/inventory/{id}/keyart

/v4/inventory/{id}/keyart

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

PUT /v4/inventory/{id}/keyart

/v4/inventory/{id}/keyart

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (2)

Option Name

Description

Label

N/A

Filename

N/A

GET /v4/inventory/{id}/keyart/url

/v4/inventory/{id}/keyart/url

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

PUT /v4/inventory/{id}/overwrite-parties

/v4/inventory/{id}/overwrite-parties

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (1)

Option Name

Description

Selectedparties

N/A

POST /v4/inventory/{id}/switch-template

/v4/inventory/{id}/switch-template

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (14)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

Chartypeid

N/A

Copyrelationships

N/A

Newtemplateid

N/A

Copyparties

N/A

POST /v4/inventory/{id}/switch-template-check

/v4/inventory/{id}/switch-template-check

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (14)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

Chartypeid

N/A

Copyrelationships

N/A

Newtemplateid

N/A

Copyparties

N/A

GET /v4/inventory/{id}/validation-errors

/v4/inventory/{id}/validation-errors

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Job (30)

POST /v4/job

/v4/job

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

GET /v4/job-processes

/v4/job-processes

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/job-statuses/{templateId}

/v4/job-statuses/{templateId}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Templateid

N/A

Response Type

N/A

GET /v4/job-templates

/v4/job-templates

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/job-templates/{id}

/v4/job-templates/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/job-templates/{id}/{tagLabel}

/v4/job-templates/{id}/{tagLabel}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Taglabel

N/A

Response Type

N/A

POST /v4/job/data-default

/v4/job/data-default

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (7)

Option Name

Description

Id

N/A

Recordids

N/A

Setchartypeid

N/A

Label

N/A

Relchartypeid

N/A

Relchildchartypeid

N/A

Copytitles

N/A

DELETE /v4/job/data-default/{setGuid}

/v4/job/data-default/{setGuid}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Setguid

N/A

Response Type

N/A

POST /v4/job/search

/v4/job/search

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Extendeddata

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/job/search-count

/v4/job/search-count

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/job/search-deleted

/v4/job/search-deleted

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (16)

Option Name

Description

Chartype

N/A

Recordid

N/A

Startdate

N/A

Enddate

N/A

Deletedbyid

N/A

Templateid

N/A

Statusid

N/A

Createdstartdate

N/A

Createdenddate

N/A

Createdbyid

N/A

Updatedstartdate

N/A

Updatedenddate

N/A

Updatedbyid

N/A

Statusupdatedstartdate

N/A

Statusupdatedenddate

N/A

Statusupdatedbyid

N/A

DELETE /v4/job/{id}

/v4/job/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Response Type

N/A

GET /v4/job/{id}

/v4/job/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Extendeddata

N/A

Response Type

N/A

PUT /v4/job/{id}

/v4/job/{id}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Extendeddata

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

GET /v4/job/{id}/audit-history

/v4/job/{id}/audit-history

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Userid

N/A

Page

N/A

Rows

N/A

Startdate

N/A

Enddate

N/A

Chartypeids

N/A

Showworkflow

N/A

Id

N/A

Response Type

N/A

GET /v4/job/{id}/audit-history-detail

/v4/job/{id}/audit-history-detail

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Isheader

N/A

Auditid

N/A

Sequence

N/A

Operationid

N/A

Includemessages

N/A

Id

N/A

Response Type

N/A

GET /v4/job/{id}/copy-warnings

/v4/job/{id}/copy-warnings

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Templateid

N/A

Response Type

N/A

GET /v4/job/{id}/data-default

/v4/job/{id}/data-default

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

POST /v4/job/{id}/data-default

/v4/job/{id}/data-default

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (7)

Option Name

Description

Id

N/A

Recordids

N/A

Setchartypeid

N/A

Label

N/A

Relchartypeid

N/A

Relchildchartypeid

N/A

Copytitles

N/A

GET /v4/job/{id}/date-alerts

/v4/job/{id}/date-alerts

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/job/{id}/date-math

/v4/job/{id}/date-math

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/job/{id}/draft-templates

/v4/job/{id}/draft-templates

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

PUT /v4/job/{id}/execute-document-workflow-action/{actionID}

/v4/job/{id}/execute-document-workflow-action/{actionID}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

Options (1)

Option Name

Description

Templateid

N/A

PUT /v4/job/{id}/execute-signature-workflow-action/{actionID}

/v4/job/{id}/execute-signature-workflow-action/{actionID}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

Options (6)

Option Name

Description

Documentid

N/A

Emails

N/A

Cc

N/A

Enforcesignorder

N/A

Expireafterdays

N/A

Warnbeforeexpiredays

N/A

PUT /v4/job/{id}/execute-workflow-action/{actionID}

/v4/job/{id}/execute-workflow-action/{actionID}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

GET /v4/job/{id}/get-lov-friendly-string/{tagLabelv}

/v4/job/{id}/get-lov-friendly-string/{tagLabelv}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Taglabel

N/A

Taglabelv

N/A

Response Type

N/A

PUT /v4/job/{id}/overwrite-parties

/v4/job/{id}/overwrite-parties

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (1)

Option Name

Description

Selectedparties

N/A

POST /v4/job/{id}/switch-template

/v4/job/{id}/switch-template

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (14)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

Chartypeid

N/A

Copyrelationships

N/A

Newtemplateid

N/A

Copyparties

N/A

POST /v4/job/{id}/switch-template-check

/v4/job/{id}/switch-template-check

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (14)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

Chartypeid

N/A

Copyrelationships

N/A

Newtemplateid

N/A

Copyparties

N/A

GET /v4/job/{id}/validation-errors

/v4/job/{id}/validation-errors

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Processes (4)

GET /v4/processes/{processID}/actions

/v4/processes/{processID}/actions

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Processid

N/A

Response Type

N/A

GET /v4/processes/{processID}/actions/{actionID}

/v4/processes/{processID}/actions/{actionID}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Processid

N/A

Actionid

N/A

Response Type

N/A

GET /v4/processes/{processID}/notifications

/v4/processes/{processID}/notifications

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Processid

N/A

Response Type

N/A

GET /v4/processes/{processID}/statuses

/v4/processes/{processID}/statuses

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Processid

N/A

Response Type

N/A

Project (30)

POST /v4/project

/v4/project

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

GET /v4/project-processes

/v4/project-processes

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/project-statuses/{templateId}

/v4/project-statuses/{templateId}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Templateid

N/A

Response Type

N/A

GET /v4/project-templates

/v4/project-templates

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/project-templates/{id}

/v4/project-templates/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/project-templates/{id}/{tagLabel}

/v4/project-templates/{id}/{tagLabel}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Taglabel

N/A

Response Type

N/A

POST /v4/project/data-default

/v4/project/data-default

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (7)

Option Name

Description

Id

N/A

Recordids

N/A

Setchartypeid

N/A

Label

N/A

Relchartypeid

N/A

Relchildchartypeid

N/A

Copytitles

N/A

DELETE /v4/project/data-default/{setGuid}

/v4/project/data-default/{setGuid}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Setguid

N/A

Response Type

N/A

POST /v4/project/search

/v4/project/search

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Extendeddata

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/project/search-count

/v4/project/search-count

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/project/search-deleted

/v4/project/search-deleted

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (16)

Option Name

Description

Chartype

N/A

Recordid

N/A

Startdate

N/A

Enddate

N/A

Deletedbyid

N/A

Templateid

N/A

Statusid

N/A

Createdstartdate

N/A

Createdenddate

N/A

Createdbyid

N/A

Updatedstartdate

N/A

Updatedenddate

N/A

Updatedbyid

N/A

Statusupdatedstartdate

N/A

Statusupdatedenddate

N/A

Statusupdatedbyid

N/A

DELETE /v4/project/{id}

/v4/project/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Response Type

N/A

GET /v4/project/{id}

/v4/project/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Extendeddata

N/A

Response Type

N/A

PUT /v4/project/{id}

/v4/project/{id}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Extendeddata

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

GET /v4/project/{id}/audit-history

/v4/project/{id}/audit-history

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Userid

N/A

Page

N/A

Rows

N/A

Startdate

N/A

Enddate

N/A

Chartypeids

N/A

Showworkflow

N/A

Id

N/A

Response Type

N/A

GET /v4/project/{id}/audit-history-detail

/v4/project/{id}/audit-history-detail

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Isheader

N/A

Auditid

N/A

Sequence

N/A

Operationid

N/A

Includemessages

N/A

Id

N/A

Response Type

N/A

GET /v4/project/{id}/copy-warnings

/v4/project/{id}/copy-warnings

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Templateid

N/A

Response Type

N/A

GET /v4/project/{id}/data-default

/v4/project/{id}/data-default

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

POST /v4/project/{id}/data-default

/v4/project/{id}/data-default

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (7)

Option Name

Description

Id

N/A

Recordids

N/A

Setchartypeid

N/A

Label

N/A

Relchartypeid

N/A

Relchildchartypeid

N/A

Copytitles

N/A

GET /v4/project/{id}/date-alerts

/v4/project/{id}/date-alerts

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/project/{id}/date-math

/v4/project/{id}/date-math

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/project/{id}/draft-templates

/v4/project/{id}/draft-templates

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

PUT /v4/project/{id}/execute-document-workflow-action/{actionID}

/v4/project/{id}/execute-document-workflow-action/{actionID}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

Options (1)

Option Name

Description

Templateid

N/A

PUT /v4/project/{id}/execute-signature-workflow-action/{actionID}

/v4/project/{id}/execute-signature-workflow-action/{actionID}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

Options (6)

Option Name

Description

Documentid

N/A

Emails

N/A

Cc

N/A

Enforcesignorder

N/A

Expireafterdays

N/A

Warnbeforeexpiredays

N/A

PUT /v4/project/{id}/execute-workflow-action/{actionID}

/v4/project/{id}/execute-workflow-action/{actionID}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

GET /v4/project/{id}/get-lov-friendly-string/{tagLabel}

/v4/project/{id}/get-lov-friendly-string/{tagLabel}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Taglabel

N/A

Response Type

N/A

PUT /v4/project/{id}/overwrite-parties

/v4/project/{id}/overwrite-parties

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (1)

Option Name

Description

Selectedparties

N/A

POST /v4/project/{id}/switch-template

/v4/project/{id}/switch-template

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (14)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

Chartypeid

N/A

Copyrelationships

N/A

Newtemplateid

N/A

Copyparties

N/A

POST /v4/project/{id}/switch-template-check

/v4/project/{id}/switch-template-check

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (14)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

Chartypeid

N/A

Copyrelationships

N/A

Newtemplateid

N/A

Copyparties

N/A

GET /v4/project/{id}/validation-errors

/v4/project/{id}/validation-errors

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Relationship (8)

GET /v4/relationship

/v4/relationship

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

POST /v4/relationship

/v4/relationship

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Parentchartypeid

N/A

Parentrecordid

N/A

Childchartypeid

N/A

Childrecordid

N/A

Sequencenumber

N/A

GET /v4/relationship-types

/v4/relationship-types

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

POST /v4/relationship/search

/v4/relationship/search

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/relationship/search-count

/v4/relationship/search-count

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/relationship/search-deleted

/v4/relationship/search-deleted

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (14)

Option Name

Description

Parentchartype

N/A

Parentrecordid

N/A

Childchartype

N/A

Childrecordid

N/A

Relrecind

N/A

Startdate

N/A

Enddate

N/A

Filterchartype

N/A

Filterchar

N/A

Filtercharvalue

N/A

Deletedbyid

N/A

Createdstartdate

N/A

Createdenddate

N/A

Createdbyid

N/A

DELETE /v4/relationship/{id}

/v4/relationship/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/relationship/{id}

/v4/relationship/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Relative-rights-profile (2)

GET /v4/relative-rights-profile

/v4/relative-rights-profile

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

POST /v4/relative-rights-profile

/v4/relative-rights-profile

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (3)

Option Name

Description

Id

N/A

Dealid

N/A

Catalogids

N/A

Right (25)

POST /v4/right

/v4/right

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

GET /v4/right-processes

/v4/right-processes

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/right-statuses/{templateId}

/v4/right-statuses/{templateId}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Templateid

N/A

Response Type

N/A

GET /v4/right-templates

/v4/right-templates

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/right-templates/{id}

/v4/right-templates/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/right-templates/{id}/{tagLabel}

/v4/right-templates/{id}/{tagLabel}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Taglabel

N/A

Response Type

N/A

POST /v4/right/search

/v4/right/search

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Extendeddata

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/right/search-count

/v4/right/search-count

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/right/search-deleted

/v4/right/search-deleted

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (16)

Option Name

Description

Chartype

N/A

Recordid

N/A

Startdate

N/A

Enddate

N/A

Deletedbyid

N/A

Templateid

N/A

Statusid

N/A

Createdstartdate

N/A

Createdenddate

N/A

Createdbyid

N/A

Updatedstartdate

N/A

Updatedenddate

N/A

Updatedbyid

N/A

Statusupdatedstartdate

N/A

Statusupdatedenddate

N/A

Statusupdatedbyid

N/A

DELETE /v4/right/{id}

/v4/right/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Response Type

N/A

GET /v4/right/{id}

/v4/right/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Extendeddata

N/A

Response Type

N/A

PUT /v4/right/{id}

/v4/right/{id}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Extendeddata

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

GET /v4/right/{id}/audit-history

/v4/right/{id}/audit-history

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Userid

N/A

Page

N/A

Rows

N/A

Startdate

N/A

Enddate

N/A

Chartypeids

N/A

Showworkflow

N/A

Id

N/A

Response Type

N/A

GET /v4/right/{id}/audit-history-detail

/v4/right/{id}/audit-history-detail

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Isheader

N/A

Auditid

N/A

Sequence

N/A

Operationid

N/A

Includemessages

N/A

Id

N/A

Response Type

N/A

GET /v4/right/{id}/copy-warnings

/v4/right/{id}/copy-warnings

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Templateid

N/A

Response Type

N/A

GET /v4/right/{id}/date-alerts

/v4/right/{id}/date-alerts

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/right/{id}/date-math

/v4/right/{id}/date-math

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/right/{id}/draft-templates

/v4/right/{id}/draft-templates

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

PUT /v4/right/{id}/execute-document-workflow-action/{actionID}

/v4/right/{id}/execute-document-workflow-action/{actionID}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

Options (1)

Option Name

Description

Templateid

N/A

PUT /v4/right/{id}/execute-signature-workflow-action/{actionID}

/v4/right/{id}/execute-signature-workflow-action/{actionID}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

Options (6)

Option Name

Description

Documentid

N/A

Emails

N/A

Cc

N/A

Enforcesignorder

N/A

Expireafterdays

N/A

Warnbeforeexpiredays

N/A

PUT /v4/right/{id}/execute-workflow-action/{actionID}

/v4/right/{id}/execute-workflow-action/{actionID}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

GET /v4/right/{id}/get-lov-friendly-string/{tagLabel}

/v4/right/{id}/get-lov-friendly-string/{tagLabel}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Taglabel

N/A

Response Type

N/A

POST /v4/right/{id}/switch-template

/v4/right/{id}/switch-template

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (14)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

Chartypeid

N/A

Copyrelationships

N/A

Newtemplateid

N/A

Copyparties

N/A

POST /v4/right/{id}/switch-template-check

/v4/right/{id}/switch-template-check

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (14)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

Chartypeid

N/A

Copyrelationships

N/A

Newtemplateid

N/A

Copyparties

N/A

GET /v4/right/{id}/validation-errors

/v4/right/{id}/validation-errors

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Royalty (25)

POST /v4/royalty

/v4/royalty

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

GET /v4/royalty-processes

/v4/royalty-processes

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/royalty-statuses/{templateId}

/v4/royalty-statuses/{templateId}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Templateid

N/A

Response Type

N/A

GET /v4/royalty-templates

/v4/royalty-templates

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/royalty-templates/{id}

/v4/royalty-templates/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/royalty-templates/{id}/{tagLabel}

/v4/royalty-templates/{id}/{tagLabel}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Taglabel

N/A

Response Type

N/A

POST /v4/royalty/search

/v4/royalty/search

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Extendeddata

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/royalty/search-count

/v4/royalty/search-count

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/royalty/search-deleted

/v4/royalty/search-deleted

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (16)

Option Name

Description

Chartype

N/A

Recordid

N/A

Startdate

N/A

Enddate

N/A

Deletedbyid

N/A

Templateid

N/A

Statusid

N/A

Createdstartdate

N/A

Createdenddate

N/A

Createdbyid

N/A

Updatedstartdate

N/A

Updatedenddate

N/A

Updatedbyid

N/A

Statusupdatedstartdate

N/A

Statusupdatedenddate

N/A

Statusupdatedbyid

N/A

DELETE /v4/royalty/{id}

/v4/royalty/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Response Type

N/A

GET /v4/royalty/{id}

/v4/royalty/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Extendeddata

N/A

Response Type

N/A

PUT /v4/royalty/{id}

/v4/royalty/{id}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Extendeddata

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

GET /v4/royalty/{id}/audit-history

/v4/royalty/{id}/audit-history

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Userid

N/A

Page

N/A

Rows

N/A

Startdate

N/A

Enddate

N/A

Chartypeids

N/A

Showworkflow

N/A

Id

N/A

Response Type

N/A

GET /v4/royalty/{id}/audit-history-detail

/v4/royalty/{id}/audit-history-detail

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Isheader

N/A

Auditid

N/A

Sequence

N/A

Operationid

N/A

Includemessages

N/A

Id

N/A

Response Type

N/A

GET /v4/royalty/{id}/copy-warnings

/v4/royalty/{id}/copy-warnings

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Templateid

N/A

Response Type

N/A

GET /v4/royalty/{id}/date-alerts

/v4/royalty/{id}/date-alerts

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/royalty/{id}/date-math

/v4/royalty/{id}/date-math

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/royalty/{id}/draft-templates

/v4/royalty/{id}/draft-templates

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

PUT /v4/royalty/{id}/execute-document-workflow-action/{actionID}

/v4/royalty/{id}/execute-document-workflow-action/{actionID}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

Options (1)

Option Name

Description

Templateid

N/A

PUT /v4/royalty/{id}/execute-signature-workflow-action/{actionID}

/v4/royalty/{id}/execute-signature-workflow-action/{actionID}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

Options (6)

Option Name

Description

Documentid

N/A

Emails

N/A

Cc

N/A

Enforcesignorder

N/A

Expireafterdays

N/A

Warnbeforeexpiredays

N/A

PUT /v4/royalty/{id}/execute-workflow-action/{actionID}

/v4/royalty/{id}/execute-workflow-action/{actionID}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

GET /v4/royalty/{id}/get-lov-friendly-string/{tagLabel}

/v4/royalty/{id}/get-lov-friendly-string/{tagLabel}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Taglabel

N/A

Response Type

N/A

POST /v4/royalty/{id}/switch-template

/v4/royalty/{id}/switch-template

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (14)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

Chartypeid

N/A

Copyrelationships

N/A

Newtemplateid

N/A

Copyparties

N/A

POST /v4/royalty/{id}/switch-template-check

/v4/royalty/{id}/switch-template-check

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (14)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

Chartypeid

N/A

Copyrelationships

N/A

Newtemplateid

N/A

Copyparties

N/A

GET /v4/royalty/{id}/validation-errors

/v4/royalty/{id}/validation-errors

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Schedule (8)

POST /v4/schedule

/v4/schedule

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

POST /v4/schedule/search-count

/v4/schedule/search-count

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

DELETE /v4/schedule/{id}

/v4/schedule/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Response Type

N/A

GET /v4/schedule/{id}

/v4/schedule/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Extendeddata

N/A

Response Type

N/A

PUT /v4/schedule/{id}

/v4/schedule/{id}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Extendeddata

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

GET /v4/schedule/{id}/audit-history

/v4/schedule/{id}/audit-history

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Userid

N/A

Page

N/A

Rows

N/A

Startdate

N/A

Enddate

N/A

Chartypeids

N/A

Showworkflow

N/A

Id

N/A

Response Type

N/A

GET /v4/schedule/{id}/audit-history-detail

/v4/schedule/{id}/audit-history-detail

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Isheader

N/A

Auditid

N/A

Sequence

N/A

Operationid

N/A

Includemessages

N/A

Id

N/A

Response Type

N/A

GET /v4/schedule/{id}/copy-warnings

/v4/schedule/{id}/copy-warnings

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Templateid

N/A

Response Type

N/A

Sso (3)

DELETE /v4/sso/{id}

/v4/sso/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/sso/{id}

/v4/sso/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

PUT /v4/sso/{id}

/v4/sso/{id}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (5)

Option Name

Description

X509certificate

N/A

Ssoauthxml

N/A

Identityprovider

N/A

Urltypeid

N/A

Url

N/A

Table (25)

POST /v4/table

/v4/table

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

GET /v4/table-processes

/v4/table-processes

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/table-statuses/{templateId}

/v4/table-statuses/{templateId}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Templateid

N/A

Response Type

N/A

GET /v4/table-templates

/v4/table-templates

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/table-templates/{id}

/v4/table-templates/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/table-templates/{id}/{tagLabel}

/v4/table-templates/{id}/{tagLabel}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Taglabel

N/A

Response Type

N/A

POST /v4/table/search

/v4/table/search

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Extendeddata

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/table/search-count

/v4/table/search-count

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (5)

Option Name

Description

Keywords

N/A

Start

N/A

Rows

N/A

Cursortoken

N/A

Sortorders

N/A

POST /v4/table/search-deleted

/v4/table/search-deleted

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (16)

Option Name

Description

Chartype

N/A

Recordid

N/A

Startdate

N/A

Enddate

N/A

Deletedbyid

N/A

Templateid

N/A

Statusid

N/A

Createdstartdate

N/A

Createdenddate

N/A

Createdbyid

N/A

Updatedstartdate

N/A

Updatedenddate

N/A

Updatedbyid

N/A

Statusupdatedstartdate

N/A

Statusupdatedenddate

N/A

Statusupdatedbyid

N/A

DELETE /v4/table/{id}

/v4/table/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Response Type

N/A

GET /v4/table/{id}

/v4/table/{id}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Revisionid

N/A

Extendeddata

N/A

Response Type

N/A

PUT /v4/table/{id}

/v4/table/{id}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Extendeddata

N/A

Response Type

N/A

Options (10)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

GET /v4/table/{id}/audit-history

/v4/table/{id}/audit-history

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Userid

N/A

Page

N/A

Rows

N/A

Startdate

N/A

Enddate

N/A

Chartypeids

N/A

Showworkflow

N/A

Id

N/A

Response Type

N/A

GET /v4/table/{id}/audit-history-detail

/v4/table/{id}/audit-history-detail

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Isheader

N/A

Auditid

N/A

Sequence

N/A

Operationid

N/A

Includemessages

N/A

Id

N/A

Response Type

N/A

GET /v4/table/{id}/copy-warnings

/v4/table/{id}/copy-warnings

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Templateid

N/A

Response Type

N/A

GET /v4/table/{id}/date-alerts

/v4/table/{id}/date-alerts

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/table/{id}/date-math

/v4/table/{id}/date-math

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

GET /v4/table/{id}/draft-templates

/v4/table/{id}/draft-templates

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

PUT /v4/table/{id}/execute-document-workflow-action/{actionID}

/v4/table/{id}/execute-document-workflow-action/{actionID}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

Options (1)

Option Name

Description

Templateid

N/A

PUT /v4/table/{id}/execute-signature-workflow-action/{actionID}

/v4/table/{id}/execute-signature-workflow-action/{actionID}

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

Options (6)

Option Name

Description

Documentid

N/A

Emails

N/A

Cc

N/A

Enforcesignorder

N/A

Expireafterdays

N/A

Warnbeforeexpiredays

N/A

PUT /v4/table/{id}/execute-workflow-action/{actionID}

/v4/table/{id}/execute-workflow-action/{actionID}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Actionid

N/A

Response Type

N/A

GET /v4/table/{id}/get-lov-friendly-string/{tagLabel}

/v4/table/{id}/get-lov-friendly-string/{tagLabel}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Taglabel

N/A

Response Type

N/A

POST /v4/table/{id}/switch-template

/v4/table/{id}/switch-template

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (14)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

Chartypeid

N/A

Copyrelationships

N/A

Newtemplateid

N/A

Copyparties

N/A

POST /v4/table/{id}/switch-template-check

/v4/table/{id}/switch-template-check

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (14)

Option Name

Description

Id

N/A

Revisionid

N/A

Title

N/A

Createdbyid

N/A

Createddate

N/A

Lastupdatedbyid

N/A

Lastupdateddate

N/A

Statusupdatedbyid

N/A

Statusupdateddate

N/A

Parentrelationshipcount

N/A

Chartypeid

N/A

Copyrelationships

N/A

Newtemplateid

N/A

Copyparties

N/A

GET /v4/table/{id}/validation-errors

/v4/table/{id}/validation-errors

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

User (4)

POST /v4/user/data-default

/v4/user/data-default

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

Options (7)

Option Name

Description

Id

N/A

Recordids

N/A

Setchartypeid

N/A

Label

N/A

Relchartypeid

N/A

Relchildchartypeid

N/A

Copytitles

N/A

DELETE /v4/user/data-default/{setGuid}

/v4/user/data-default/{setGuid}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Setguid

N/A

Response Type

N/A

GET /v4/user/{id}/data-default

/v4/user/{id}/data-default

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

POST /v4/user/{id}/data-default

/v4/user/{id}/data-default

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Id

N/A

Response Type

N/A

Options (7)

Option Name

Description

Id

N/A

Recordids

N/A

Setchartypeid

N/A

Label

N/A

Relchartypeid

N/A

Relchildchartypeid

N/A

Copytitles

N/A

Worksheet (2)

GET /v4/worksheet

/v4/worksheet

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Response Type

N/A

GET /v4/worksheet/{worksheetId}

/v4/worksheet/{worksheetId}

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

queryParams

N/A

queryParams.Query Param Key

N/A

queryParams.Query Param Value

N/A

Worksheetid

N/A

Response Type

N/A