Get all contracts

get https://api.dastra.eu/v1/ws/{workspaceId}/Contracts

Path Params

workspaceId

string

required

Query Params

includeRevisions

boolean

freshnessState

string

masterId

uuid

Get all contract version related to this one

string

length ≤ 400

tags

array of uuids

tags

users

array of int32s

users

states

array of strings

states

workflows

array of int32s

workflows

ids

array of uuids

ids

stakeholders

array of uuids

stakeholders

assets

array of uuids

assets

areaId

int32

start

date-time

end

date-time

archived

boolean

expirationState

string

select

string

length ≤ 700

Comma separated list of fields

page

int32

1 to 2147483647

Pagination index (1 based, page 1 = 1, page 2 = 2...)

size

int32

1 to 9999

Size of the result page (default: 20, max 500)

skip

int32

The number of items to skip (if not provided, it will use the default page and size prop)

sortBy

string

length ≤ 100

The field to sort

asc

boolean

True to sort ascending

filters

string

length ≤ 3000

A serialized as json filter string using the JsonRuleEngine.net format
https://github.com/antoinebidault/JsonRuleEngine.Net
The filters is a query param, that's why he must be properly serialized as a json string and url encoded
e.g. {"field":"ProcessingType", "operator":"notEqual", "value": "Done"}
The field prop must match one property name of the object (present in the output results)
The operator can be equal,
notEqual,
lessThan,
lessThanInclusive,
greaterThan,
greaterThanInclusive,
in,
notIn,
contains,
doesNotContains,
isNull,
isNotNull,
isEmpty
You can combine the filters as following :
{ "separator":"Or","rules": [{"field":"ProcessingType", "operator":"notEqual", "value": "Done"},{"field":"ProcessingType", "operator":"isNull"}]}
Serialize the filter param as following:
?filters=${uriEncodeComponent(JSON.stringify({"field":"ProcessingType", "operator":"notEqual", "value": "Done"}))}

PaginationDisabled

boolean

Response

Response body

object

items

array of objects | null

items

object

dateCreation

date-time

Contract label

dateUpdate

date-time | null

attachmentsCount

int32

signatureTotalCount

int32

signatureDoneCount

int32

signaturePendingCount

int32

stakeholders

array of objects | null

stakeholders

object

label

string

required

length ≥ 1

uuid

Dastra unique identifier

ref

string | null

Internal reference

dateCreation

date-time

dateUpdate

date-time | null

reviewDate

date-time | null

Date of the last review to calculate the freshness

nextReviewDate

date-time | null

Overrides the global policy review date

logoUrl

string | null

state

string

New Active

actorType

string

Physical Morale

vendorType

string

B2B B2C

description

string | null

countryCode

string | null

readonly

boolean

string | null

phoneNumber

string | null

contactName

string | null

contactPosition

string | null

immatriculationNumber

string | null

websiteUrl

string | null

address

string | null

zipCode

string | null

city

string | null

workflowStepId

int32

source

string

Intern Import Library InboundEmail Api AI Questionnaire Workflow

users

array of objects | null

users

object

role

string

Accountable Responsible Informed

int32

displayName

string | null

familyName

string | null

givenName

string | null

active

boolean

color

string | null

avatarUrl

string | null

tenantId

int32

assets

array of objects | null

assets

object

uuid

source

string

Intern Import Library InboundEmail Api AI Questionnaire Workflow

ref

string | null

Internal reference specific to the customer

label

string

required

length between 1 and 255

Name of the asset
e.g. Microsoft Teams, Github, Amazon S3...

editor

object

editorId

uuid | null

The publisher identifier (write)

address

string | null

countryCode

string | null

The country where is located the asset
2 characters ISO format
e.g. FR,UK,...

zipCode

string | null

Zip code

city

string | null

privacyPolicyUrl

string | null

Asset privacy policy url

type

string

Software Building Network Material Data People Process Algorithm

description

string | null

Description of the asset

logoUrl

string | null

Logo url / must be a valid .png or .jpg format url

applicationState

string

InProduction InDevelopment Stopped

state

string

Draft Active

applicationType

string

Software WebApp Saas Module Other

hostingType

string

InHouse OutSourced

developmentType

string

InHouse OutSourced

maintenanceType

string

InHouse OutSourced

supportType

string

InHouse OutSourced

tags

array of objects | null

tags

object

uuid

label

string

required

length between 1 and 80

type

string

Type of tags

DataProcessing DataSubjectRequest DataBreach Task Actor SecurityMeasure Asset Risk DataRetentionRule AuditTemplate AiSystem Contract AiModel

color

string | null

readonly

boolean

Set to true if it is merged with a master relationship

dateCreation

date-time

dateUpdate

date-time | null

creator

object

creatorId

int32 | null

owner

object

ownerId

int32 | null

workflowStepId

int32

customFields

object | null

Custom field values

Has additional fields

reviewDate

date-time | null

Date of the last review to calculate the freshness

nextReviewDate

date-time | null

Overrides the global policy review date

workflowStep

object

area

object

uuid

masterId

uuid

The master contract identifier

label

string

required

length between 1 and 160

Contract label

description

string | null

Description

start

date-time

Beginning of the contract

deadline

date-time | null

End date of the contract
It will condition renew alert system

internalSignatureDate

date-time | null

End date of the contract
It will condition renew alert system

revisionNumber

int32

isRevision

boolean

parentId

uuid | null

creatorId

int32 | null

versionDescription

string | null

Version description

source

string

Intern Import Library InboundEmail Api AI Questionnaire Workflow

areaId

int32

Organizational unit identifier

ref

string | null

Internal reference

state

string

Draft Pending Active Expired

descriptionHtml

string | null

Description

archived

boolean

reviewDate

date-time | null

Date of the last review to calculate the freshness

nextReviewDate

date-time | null

Overrides the global policy review date

nbDaysRenewal

int32

Number of days of renewal

workflowStepId

int32

readonly

boolean

Set to true if it is merged with a master relationship

customFields

object | null

Custom field values

Has additional fields

tags

array of objects | null

Associated tags with colors

tags

object

uuid

label

string

required

length between 1 and 80

type

string

Type of tags

DataProcessing DataSubjectRequest DataBreach Task Actor SecurityMeasure Asset Risk DataRetentionRule AuditTemplate AiSystem Contract AiModel

color

string | null

isOverdue

boolean

Wether the contract has overflown the Deadline date

total

int64

size

int32

page

int32

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.dastra.eu/v1/ws/workspaceId/Contracts \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK