Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

field name

format /
presence

description /
value example

id

UUID

This contract identifier.

always

15f5b906-1076-4539-a9ac-0be80bdef973

templateId

printable US-ASCII string

Confluence page or Jira issue identifier.

always

"654321"

collectionId

printable US-ASCII string

Confluence space or Jira project identifier.

always

"123456"

name

printable Unicode string

This contract name.

always

"NDA"

createdById

printable US-ASCII string

Atlassian user identifier of this contract creator.

always

"123456:b84aeffd-32e5-4b4b-a012-89bf06cae06e"

creationTimestamp

ISO 8601

Time at which this contract creation has been requested.

always

"2022-09-16T13:28:37.4951Z"

expirationTimestamp

ISO 8601

Time at which this contract become expired.

always

"2022-09-23T13:28:37.4951Z"

sequentialSigning

boolean

Is an invitation email sent after a previous signer decision ?

always

false

archivalTimestamp

ISO 8601

Time at which this contract has been move to the archive.

conditional

"2022-09-30T13:28:37.932523Z"

status

"sent" or
"ongoing" or
"rejected" or
"signed" or
"expired"

This contract status:

  • "sent" - URLs to signing page are available but no signature or rejection has been made.

  • "ongoing" - at least one signature is collected

  • "rejected" - one of the signers rejected the contract

  • "signed" - all signatures have been collected

  • "expired" - not all signatures have been collected before expiration timestamp

always

"signed"

signers

array of Signer Objects

Present only in the GET /webapi/contracts/{contract-id} responses.

conditional

finalizedPdf

Attachment Object

Present if there is an attachment in the Confluence/Jira containing PDF with the final version of the contract.

conditional

certificatePdf

Attachment Object

Present if there is an attachment in the Confluence/Jira containing PDF certificate for the final version of the contract.

conditional

...