Active Steward API 1.0¶
Servers¶
| Description | URL |
|---|---|
| Your Company's Active Steward Instance | /ActiveSteward |
Studies¶
GET /api/studies/{id}¶
Get a Study
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "001-Cat Z-Analysis-Int"
},
"status": {
"type": "string",
"enum": [
"PLANNED",
"CONTRACTING",
"ACTIVE",
"COMPLETE",
"CANCELLED"
],
"example": "ACTIVE"
},
"start": {
"type": "string",
"format": "date"
},
"end": {
"type": "string",
"format": "date"
},
"purpose": {
"type": "string",
"enum": [
"VI",
"VII",
"VIII",
"IX",
"X",
"K_REACH",
"UK_REACH",
"INDIA_REACH",
"TURKEY_REACH",
"COLOMBIA_REACH",
"EU_BIO",
"EU_PLANT",
"UD_TSCA",
"PROD_SAFETY",
"INV_WORK"
]
}
},
"required": [
"end",
"name",
"partitionId",
"start",
"status"
]
}
Response 404 Not Found
Response 500 Internal Server Error
Response 403 Forbidden
PUT /api/studies/{id}¶
Fully Update a Study
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI"
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "001-Cat Z-Analysis-Int"
},
"status": {
"type": "string",
"enum": [
"PLANNED",
"CONTRACTING",
"ACTIVE",
"COMPLETE",
"CANCELLED"
],
"example": "ACTIVE"
},
"start": {
"type": "string",
"format": "date"
},
"end": {
"type": "string",
"format": "date"
},
"purpose": {
"type": "string",
"enum": [
"VI",
"VII",
"VIII",
"IX",
"X",
"K_REACH",
"UK_REACH",
"INDIA_REACH",
"TURKEY_REACH",
"COLOMBIA_REACH",
"EU_BIO",
"EU_PLANT",
"UD_TSCA",
"PROD_SAFETY",
"INV_WORK"
]
}
},
"required": [
"end",
"name",
"partitionId",
"start",
"status"
]
}
Response 400 Bad Request
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "001-Cat Z-Analysis-Int"
},
"status": {
"type": "string",
"enum": [
"PLANNED",
"CONTRACTING",
"ACTIVE",
"COMPLETE",
"CANCELLED"
],
"example": "ACTIVE"
},
"start": {
"type": "string",
"format": "date"
},
"end": {
"type": "string",
"format": "date"
},
"purpose": {
"type": "string",
"enum": [
"VI",
"VII",
"VIII",
"IX",
"X",
"K_REACH",
"UK_REACH",
"INDIA_REACH",
"TURKEY_REACH",
"COLOMBIA_REACH",
"EU_BIO",
"EU_PLANT",
"UD_TSCA",
"PROD_SAFETY",
"INV_WORK"
]
}
},
"required": [
"end",
"name",
"partitionId",
"start",
"status"
]
}
Response 404 Not Found
Response 500 Internal Server Error
Response 403 Forbidden
DELETE /api/studies/{id}¶
Delete a Study
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 204 No Content
Response 403 Forbidden
Response 500 Internal Server Error
PATCH /api/studies/{id}¶
Partially Update a Study
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI"
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "001-Cat Z-Analysis-Int"
},
"status": {
"type": "string",
"enum": [
"PLANNED",
"CONTRACTING",
"ACTIVE",
"COMPLETE",
"CANCELLED"
],
"example": "ACTIVE"
},
"start": {
"type": "string",
"format": "date"
},
"end": {
"type": "string",
"format": "date"
},
"purpose": {
"type": "string",
"enum": [
"VI",
"VII",
"VIII",
"IX",
"X",
"K_REACH",
"UK_REACH",
"INDIA_REACH",
"TURKEY_REACH",
"COLOMBIA_REACH",
"EU_BIO",
"EU_PLANT",
"UD_TSCA",
"PROD_SAFETY",
"INV_WORK"
]
}
},
"required": [
"end",
"name",
"partitionId",
"start",
"status"
]
}
Response 400 Bad Request
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "001-Cat Z-Analysis-Int"
},
"status": {
"type": "string",
"enum": [
"PLANNED",
"CONTRACTING",
"ACTIVE",
"COMPLETE",
"CANCELLED"
],
"example": "ACTIVE"
},
"start": {
"type": "string",
"format": "date"
},
"end": {
"type": "string",
"format": "date"
},
"purpose": {
"type": "string",
"enum": [
"VI",
"VII",
"VIII",
"IX",
"X",
"K_REACH",
"UK_REACH",
"INDIA_REACH",
"TURKEY_REACH",
"COLOMBIA_REACH",
"EU_BIO",
"EU_PLANT",
"UD_TSCA",
"PROD_SAFETY",
"INV_WORK"
]
}
},
"required": [
"end",
"name",
"partitionId",
"start",
"status"
]
}
Response 404 Not Found
Response 500 Internal Server Error
Response 403 Forbidden
GET /api/studies¶
Get all Studies
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
page |
query | integer | 0 | No | Zero-based page index (0..N) |
size |
query | integer | 20 | No | The size of the page to be returned |
sort |
query | array | No | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Response 200 OK
{
"totalElements": 27,
"totalPages": 140,
"first": true,
"size": 67,
"content": [
{
"id": 1,
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI"
}
],
"number": 25,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"last": true,
"pageable": {
"offset": 254,
"sort": null,
"paged": true,
"unpaged": true,
"pageSize": 233,
"pageNumber": 195
},
"numberOfElements": 46,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StudyData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"last": {
"type": "boolean"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
POST /api/studies¶
Create a Study
Request body
{
"id": 1,
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI"
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "001-Cat Z-Analysis-Int"
},
"status": {
"type": "string",
"enum": [
"PLANNED",
"CONTRACTING",
"ACTIVE",
"COMPLETE",
"CANCELLED"
],
"example": "ACTIVE"
},
"start": {
"type": "string",
"format": "date"
},
"end": {
"type": "string",
"format": "date"
},
"purpose": {
"type": "string",
"enum": [
"VI",
"VII",
"VIII",
"IX",
"X",
"K_REACH",
"UK_REACH",
"INDIA_REACH",
"TURKEY_REACH",
"COLOMBIA_REACH",
"EU_BIO",
"EU_PLANT",
"UD_TSCA",
"PROD_SAFETY",
"INV_WORK"
]
}
},
"required": [
"end",
"name",
"partitionId",
"start",
"status"
]
}
Response 400 Bad Request
Response 403 Forbidden
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "001-Cat Z-Analysis-Int"
},
"status": {
"type": "string",
"enum": [
"PLANNED",
"CONTRACTING",
"ACTIVE",
"COMPLETE",
"CANCELLED"
],
"example": "ACTIVE"
},
"start": {
"type": "string",
"format": "date"
},
"end": {
"type": "string",
"format": "date"
},
"purpose": {
"type": "string",
"enum": [
"VI",
"VII",
"VIII",
"IX",
"X",
"K_REACH",
"UK_REACH",
"INDIA_REACH",
"TURKEY_REACH",
"COLOMBIA_REACH",
"EU_BIO",
"EU_PLANT",
"UD_TSCA",
"PROD_SAFETY",
"INV_WORK"
]
}
},
"required": [
"end",
"name",
"partitionId",
"start",
"status"
]
}
Response 500 Internal Server Error
GET /api/studies/{id}/costs¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
[
{
"study": {
"id": 49,
"code": "string",
"status": "PLANNED",
"species": [
{
"id": 225,
"description": "string"
}
],
"purpose": "VI",
"start": "2022-04-13",
"end": "2022-04-13",
"folder": {
"id": 83,
"partitionId": 238,
"name": "string",
"parent": null,
"children": null,
"documents": [
{
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 77,
"partition": {
"id": 41,
"partitionName": "string",
"logoID": "b881879c-aea7-463d-8f19-74436eea08a5",
"email": "string",
"userPartitions": [
{
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 178,
"user": {
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 179,
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"principal": "string",
"lastLoggedIn": "2022-04-13T15:42:05.901Z",
"created": "2022-04-13T15:42:05.901Z",
"enabled": true,
"locked": true,
"failedLoginCount": 269,
"notActiveAfter": "2022-04-13",
"passwordExpires": "2022-04-13",
"deleted": true,
"version": 267,
"owner": {
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 141,
"name": "string",
"version": 179,
"companyNo": "string",
"vatNo": "string",
"remarks": "string",
"dunnNo": "string",
"utr": "string",
"uclidID": "string",
"reachID": "string",
"clientPartitionId": 88,
"sapBusinessReference": "string",
"hasInvoicingAddress": true,
"deleted": true,
"entityEntityGroups": [
{
"id": 104,
"entity": null,
"entityGroup": {
"name": "string",
"partitionId": 201
}
}
],
"invoiceOverdueDays": 211,
"comments": [
{
"id": 259,
"replyTo": {
"id": 80,
"replyTo": null,
"createdDate": "2022-04-13T15:42:05.901Z",
"user": null,
"contact": {
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 56,
"partition": null,
"user": null,
"title": "MR",
"firstName": "string",
"lastName": "string",
"nameSuffix": "string",
"jobDescription": "string",
"email": "string",
"telephone": "string",
"fax": "string",
"mobile": "string",
"skype": "string",
"remarks": "string",
"reachIt": true,
"productEntityContacts": [
{
"id": 86,
"productEntity": {
"id": 218,
"product": {
"id": 143,
"name": "string",
"ownerManufacturer": "string",
"partitionId": 131,
"archived": true
},
"baseEntity": null,
"entityRoles": [
{
"id": "string",
"display": "string",
"name": "string",
"url": "string",
"partitionId": 215,
"partition": null,
"idInPartition": 118,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": {
"name": "string",
"id": {},
"url": "string",
"partitionId": 101,
"partition": null,
"display": "string",
"idInPartition": 140,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
},
"iconClass": "string",
"iconColour": "string"
}
],
"deleted": true,
"partitionId": 11
},
"contact": null,
"deleted": true
}
],
"productPartyContacts": [
{
"id": 167,
"productParty": {
"id": 122,
"product": null,
"party": {
"id": 1,
"entity": null,
"description": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"townCity": "string",
"countyStateRegion": "string",
"postcode": "string",
"country": {
"id": 272,
"name": "string",
"iso3166alpha2CountryCode": "string",
"iso3166alpha3CountryCode": "string",
"iso3166numeric3CountryCode": "string",
"partitionId": 253
},
"website": "string",
"telephone": "string",
"fax": "string",
"remarks": "string",
"addressType": "PRIMARY_ADDRESS",
"lastUpdated": "2022-04-13T15:42:05.901Z",
"lastUpdatedByEmail": "string",
"lastUpdatedById": 246,
"sapBusinessReference": "string",
"deleted": true,
"contacts": null,
"plants": [
{
"id": 184,
"party": null,
"name": "string",
"plantCode": "string",
"constituentPlants": [
{
"id": 127,
"constituent": {
"id": 272,
"casNumber": "string",
"ecName": "string",
"ecNumber": "string",
"ecDescription": "string",
"iupac": "string",
"iuclidUuid": "string",
"tsca": "string",
"molecularFormula": "string",
"smiles": "string",
"inChl": "string",
"name": "string",
"partitionId": 132,
"type": "ACTIVE_INGREDIENT",
"archived": true
},
"plant": null
}
],
"productPlants": [
{
"id": 24,
"product": null,
"plant": null
}
]
}
],
"lastUpdatedBy": null,
"partitionId": 62
},
"deleted": true
},
"contact": null,
"deleted": true
}
],
"productContacts": [
{
"id": 96,
"product": null,
"contact": null,
"contactType": "KEY",
"deleted": true
}
],
"constituentEntityContacts": [
{
"id": 97,
"constituentEntity": {
"id": 134,
"constituent": null,
"entity": null,
"entityRoles": null,
"partitionId": 0
},
"contact": null,
"deleted": true
}
],
"constituentPartyContacts": [
{
"id": 207,
"constituentParty": {
"id": 269,
"constituent": null,
"party": null,
"deleted": true
},
"contact": null,
"deleted": true
}
],
"constituentContacts": [
{
"id": 156,
"constituent": null,
"contact": null,
"contactType": "KEY",
"deleted": true
}
],
"deleted": true,
"contactGroups": [
{
"id": 275,
"contact": null,
"contactGroup": {
"groupName": "string"
},
"deleted": true
}
],
"primaryInvoicingEntities": null,
"secondaryInvoicingEntities": null,
"tonnageAndUseEnquiries": [
{
"reachLegislation": "EU_REACH",
"contact": null,
"baseEntity": null,
"enquiryYear": 221,
"documentLink": {
"id": 166,
"contact": null,
"code": "string",
"created": "2022-04-13T15:42:05.901Z",
"documentLinkAttachments": [
{
"id": 9,
"document": null,
"documentLinks": null
}
],
"expiryDays": 37,
"clientPartition": null,
"allDownloaded": true,
"link": "string",
"autoExpire": true,
"reminderDate": "2022-04-13",
"dateAllDownLoaded": "2022-04-13T15:42:05.901Z",
"emails": [
{
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 109,
"partition": null,
"title": "string",
"description": "string",
"fileName": "string",
"originalFileName": "string",
"link": true,
"fileSize": 183,
"uploadDate": "2022-04-13T15:42:05.901Z",
"documentCreationDate": "2022-04-13",
"fileType": "UNKNOWN",
"docType": "DOCUMENT",
"expiryDate": "2022-04-13",
"retentionDate": "2022-04-13",
"permanent": true,
"documentTagSet": [
{
"id": 177,
"document": null,
"tag": {
"id": {
"partitionId": 225,
"id": 21
},
"tagText": "string"
},
"deleted": true
}
],
"documentContactGroups": [
{
"id": 80,
"document": null,
"contactGroup": null,
"deleted": true
}
],
"documentEntityGroups": [
{
"id": 147,
"document": null,
"entityGroup": null
}
],
"linkedDocuments": null,
"version": 237,
"versionIdentifier": "string",
"currentDocumentId": 173,
"currentDocument": null,
"newsItem": true,
"issues": [
{
"id": 233,
"clientPartition": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdated": "2022-04-13T15:42:05.901Z",
"version": 105,
"issue": "string",
"statement": "string",
"basis": "string",
"reviewDate": "2022-04-13",
"reviewNotified": true,
"supportingDocuments": null,
"products": null,
"constituents": null,
"studies": null,
"entities": null,
"notes": "string",
"inventoryId": "0942418a-0ba5-4624-b2be-25ae8f5431f6",
"comments": [
{
"id": 35,
"replyTo": null,
"createdDate": "2022-04-13T15:42:05.901Z",
"user": null,
"contact": null,
"text": "string",
"published": true,
"replies": null,
"notifications": [
{
"id": 171,
"partitionId": 63,
"created": "2022-04-13T15:42:05.901Z",
"user": null,
"read": true,
"comment": null,
"type": "ADDED",
"baseUrl": "string",
"parent": {
"comments": null,
"watching": true,
"watchingUsers": null,
"commentType": "string",
"commentsPermission": "ROLE_PRE_AUTH",
"commentsEditPermission": "ROLE_PRE_AUTH",
"commentDisplayUrl": "string",
"name": "string",
"id": {},
"url": "string",
"partitionId": 272,
"partition": null,
"display": "string",
"idInPartition": 206,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
},
"url": "string",
"mailjetTemplateName": "string",
"displayCode": "string",
"mailjetTemplateVars": {},
"mailjetTemplateEmail": {
"templateName": "string",
"subject": "string",
"globalTemplateVars": {},
"recipients": [
{
"email": "string",
"templateVars": {}
}
],
"attachments": [
{
"type": "string",
"filename": "string",
"data": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"priority": "LOW_FIFO"
},
"serverCreatedDate": "2022-04-13T15:42:05.901Z",
"name": "string",
"partition": null,
"display": "string",
"idInPartition": 145,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"hidden": true,
"reply": true,
"greatestAncestor": null,
"replyToIsUnpublished": true,
"serverCreatedReadableDate": "string",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"lastUpdatedById": 22,
"name": "string",
"partition": null,
"display": "string",
"idInPartition": 13,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"calendarSource": "PRODUCT",
"calendarExtendedProps": {},
"calendarEnd": "2022-04-13T15:42:05.901Z",
"allDay": true
}
],
"watchingUsers": null,
"relevantEntities": null,
"tasks": [
{
"id": 233,
"clientPartition": null,
"campaign": {
"id": 243,
"clientPartition": null,
"name": "string",
"description": "string",
"startDate": "2022-04-13",
"endDate": "2022-04-13",
"menuName": "string",
"section": {
"id": 204,
"clientPartition": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdated": "2022-04-13T15:42:05.901Z",
"campaign": null,
"constituent": null,
"name": "string",
"parentSection": null,
"children": null,
"expand": true,
"deleted": true,
"pages": [
{
"id": 147,
"clientPartition": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdated": "2022-04-13T15:42:05.901Z",
"name": "string",
"index": 30,
"content": "string",
"caretPosition": "string",
"type": "COMPANY_INFO",
"roles": [
{
"id": 237,
"clientPartition": null,
"name": "string",
"description": "string",
"campaign": null,
"campaignContacts": [
{
"id": 141,
"clientPartition": null,
"campaign": null,
"contact": null,
"roles": null,
"tasks": null,
"pages": null,
"lastLoggedIn": "2022-04-13T15:42:05.901Z",
"deleted": true,
"fullName": "string",
"email": "string",
"user": null,
"lastName": "string",
"firstName": "string",
"recordName": "string",
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"fullNameFallback": "string",
"name": "string",
"url": "string",
"partitionId": 121,
"partition": null,
"display": "string",
"idInPartition": 135,
"displayAttributes": [
{}
],
"displayCodePartial": "string",
"displayArgs": [
"string"
]
}
],
"pages": null,
"tasks": null,
"contactCount": 9,
"tabCount": 290,
"taskCount": 177,
"inUse": true,
"breadcrumbParent": null,
"iconClass": "string",
"url": "string",
"partitionId": 117,
"partition": null,
"display": "string",
"idInPartition": 155,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"iconColour": "string"
}
],
"access": "PUBLIC",
"deleted": true,
"source": "ENTITY",
"entity": null,
"entityGroup": null,
"cutOffDate": "2022-04-13",
"invoicePageInfo": {
"purchaseNumber": "string",
"showing": "BOTH",
"otherEntity": null,
"address": "string",
"vat": "string",
"invoicePageFooter": "string",
"invoicingContacts": "string"
},
"docType": "DOCUMENT",
"tags": null,
"task": null,
"notifications": [
{
"id": 194,
"partitionId": 1,
"created": "2022-04-13T15:42:05.901Z",
"user": null,
"read": true,
"page": null,
"type": "ADDED",
"baseUrl": "string",
"url": "string",
"mailjetTemplateName": "string",
"displayCode": "string",
"mailjetTemplateVars": {},
"mailjetTemplateEmail": null,
"serverCreatedDate": "2022-04-13T15:42:05.901Z",
"name": "string",
"partition": null,
"display": "string",
"idInPartition": 164,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"hidden": true,
"public": true,
"visible": true,
"url": "string",
"issues": [
{
"uuid": "08894ecc-c7cb-48e8-a413-6510729dda14",
"error": "string",
"html": "string"
}
],
"archived": true,
"contact": null,
"activeEntities": null,
"constituent": null,
"sections": null,
"nameWithSections": "string",
"ancestorsString": "string",
"campaignNavigationLevel": 223,
"campaignContacts": null,
"menuIndex": 223,
"allUsers": true,
"highestSection": null,
"allFields": "string",
"iconClass": "string",
"menuParent": {
"campaignNavigationLevel": 220,
"expand": true,
"menuIndex": 34,
"menuParent": null,
"menuAncestors": null,
"name": "string",
"id": {},
"url": "string",
"partitionId": 277,
"partition": null,
"display": "string",
"idInPartition": 154,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
},
"associatedToArchivedContact": true,
"membersUrl": "string",
"entities": null,
"expand": true,
"menuAncestors": null,
"partitionId": 238,
"partition": null,
"display": "string",
"idInPartition": 231,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"iconColour": "string",
"lastUpdatedById": 206
}
],
"menuIndex": 240,
"url": "string",
"display": "string",
"descendants": null,
"ancestorsString": "string",
"campaignNavigationLevel": 57,
"allPages": null,
"recordName": "string",
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"menuParent": null,
"updateOptions": {
"campaignId": 141,
"updateRole": true,
"defaultRoleId": 83,
"createCampaigns": true,
"createContacts": true,
"forCampaign": true
},
"menuAncestors": null,
"partitionId": 215,
"partition": null,
"idInPartition": 113,
"displayAttributes": [
{}
],
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"lastUpdatedById": 137
},
"expand": true,
"footerAddress": "string",
"footerLink": "string",
"footerPhone": "string",
"termsAndConditionsText": "string",
"menuIndex": 226,
"deleted": true,
"uploadingLock": true,
"contacts": null,
"roles": null,
"sections": null,
"pages": null,
"tasks": null,
"taskGroups": [
{
"id": 217,
"clientPartition": null,
"name": "string",
"description": "string",
"campaign": null,
"taskLinks": [
{
"id": {
"taskGroupId": 105,
"taskId": 263
},
"taskGroup": null,
"task": null,
"index": 105
}
],
"pages": [
{
"id": 279,
"taskGroup": null,
"page": null,
"cutOffDate": "2022-04-13",
"index": 285
}
],
"breadcrumbParent": null,
"iconClass": "string",
"descriptionContainsHtml": true,
"url": "string",
"partitionId": 97,
"partition": null,
"display": "string",
"idInPartition": 49,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"iconColour": "string"
}
],
"campaignEvents": [
{
"id": 48,
"campaign": null,
"eventTime": "2022-04-13T15:42:05.901Z",
"campaignContacts": null,
"displayName": "string"
}
],
"watchingUsers": null,
"securityIssueNotifications": [
{
"id": 76,
"partitionId": 92,
"created": "2022-04-13T15:42:05.901Z",
"user": null,
"read": true,
"campaign": null,
"hasPageSecurityIssues": true,
"url": "string",
"mailjetTemplateName": "string",
"displayCode": "string",
"mailjetTemplateVars": {},
"displayIssueType": "string",
"mailjetTemplateEmail": null,
"serverCreatedDate": "2022-04-13T15:42:05.901Z",
"name": "string",
"partition": null,
"display": "string",
"idInPartition": 262,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"visible": true,
"url": "string",
"display": "string",
"campaignNavigationLevel": 246,
"onlyPublicAccessForUser": true,
"watching": true,
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"menuParent": null,
"footerPresent": true,
"closed": true,
"menuAncestors": null,
"partitionId": 102,
"partition": null,
"idInPartition": 38,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"emailCode": "string",
"emailPrefix": "string",
"oneToOne": true
},
"campaignContact": null,
"role": null,
"access": "PUBLIC",
"template": {
"id": 255,
"clientPartition": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdated": "2022-04-13T15:42:05.901Z",
"campaign": null,
"name": "string",
"instructions": "string",
"endingInstructions": "string",
"type": "DISCUSSION",
"fields": [
{
"id": 238,
"template": null,
"type": "BOOLEAN",
"index": 8,
"required": true,
"range": true,
"rangeMinimum": 10.12,
"rangeMaximum": 10.12,
"question": "string",
"defaultValue": "string",
"options": [
{
"id": 107,
"template": null,
"option": "string"
}
]
}
],
"iconClass": "string",
"lastUpdatedById": 59,
"url": "string",
"partitionId": 22,
"partition": null,
"display": "string",
"idInPartition": 104,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconColour": "string"
},
"dueByDate": "2022-04-13",
"closesOnDate": "2022-04-13",
"instructions": "string",
"endingInstructions": "string",
"name": "string",
"taskType": "DISCUSSION",
"document": null,
"documentTwo": null,
"documentLinks": [
{
"id": {
"taskId": 125,
"documentId": 89,
"documentPartitionId": 23,
"document": null
},
"task": null,
"document": null,
"index": 82,
"campaign": null
}
],
"constituent": null,
"surveyFields": [
{
"id": 189,
"fieldType": "BOOLEAN",
"name": "string",
"defaultValue": "string",
"selectOptionValues": [
{
"id": 244,
"surveyField": null,
"value": "string",
"index": 291
}
],
"index": 252,
"required": true,
"range": true,
"rangeMinimum": 10.12,
"rangeMaximum": 10.12,
"campaignContactTask": null,
"surveyValues": [
{
"id": 192,
"surveyField": null,
"value": "string",
"deleted": true,
"campaignContactEvent": {
"id": 137,
"clientPartition": null,
"task": null,
"contact": null,
"eventDate": "2022-04-13T15:42:05.901Z",
"completed": true,
"surveyValues": null,
"documentDates": [
{
"id": 46,
"document": null,
"dateAccessed": "2022-04-13T15:42:05.901Z",
"events": null
}
],
"useSurvey": {
"id": 263,
"clientPartition": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdated": "2022-04-13T15:42:05.901Z",
"event": null,
"contact": null,
"campaign": null,
"entity": null,
"company": "string",
"referrer": null,
"referralCode": "string",
"role": null,
"date": "2022-04-13",
"constituent": null,
"status": "ACTIVE",
"importedTonnage": 10.12,
"exportedTonnage": 10.12,
"orTonnage": 10.12,
"useTonnages": [
{
"id": 272,
"useSurvey": null,
"use": "37d4d1f1-e903-4f48-a099-508c63f12d37",
"useNameFallback": "string",
"useLifeCycleFallback": "string",
"tonnage": 10.12,
"maxSiteTonnage": 10.12,
"notes": "string",
"exposureMonitored": true,
"proceduresDocumented": true,
"legalEmissions": true,
"functions": [
{
"id": 125,
"useSurveyTonnage": null,
"functionId": 4,
"functionNameFallback": "string"
}
],
"tonnageDetails": [
{
"id": 70,
"useSurveyTonnage": null,
"productCategory": "string",
"processCategory": 152,
"localVentilation": true,
"roomVentilation": "BASIC",
"additionalMeasures": [
"CLOSED_LOOP_SAMPLING"
],
"goggles": true,
"masks": "YES_10",
"gloves": "YES_80",
"location": "INDOOR",
"duration": "BELOW_15",
"temperature": 10.12,
"concentrationRange": "BELOW_1",
"concentration": 10.12
}
],
"sdsFileIds": [
"4f8aa589-c960-4c72-80c0-4f79ba97da12"
],
"sdsFileNames": [
"string"
]
}
],
"notes": "string",
"empty": true,
"ceasedManufacture": true,
"onlyRepresentative": true,
"entities": null,
"lastUpdatedById": 196,
"name": "string",
"url": "string",
"partitionId": 246,
"partition": null,
"display": "string",
"idInPartition": 53,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
},
"fileId": "f04cfd1b-513e-4581-8682-296593b4b36f",
"url": "string",
"display": "string",
"campaign": null,
"responses": [
{
"id": 20,
"surveyField": null,
"value": "string",
"deleted": true,
"fieldType": "BOOLEAN",
"file": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=",
"fileName": "string",
"valueAsUUID": "75120c5c-428e-4767-8913-d998ac3319c7",
"valueAsDate": "2022-04-13",
"valueSanitized": "string"
}
],
"deleted": true,
"calendarStart": "2022-04-13T15:42:05.901Z",
"responsesDeleted": true,
"downloadedDocumentIds": [
49
],
"downloadedOldDocumentsOf": [
142
],
"calendarSource": "PRODUCT",
"calendarExtendedProps": {},
"calendarEnd": "2022-04-13T15:42:05.901Z",
"allDay": true,
"calendarDisplay": "string",
"name": "string",
"partitionId": 191,
"partition": null,
"idInPartition": 216,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
},
"fieldType": "BOOLEAN",
"file": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=",
"fileName": "string",
"valueAsUUID": "148fcde5-6101-4317-adb5-f41a0a50be25",
"valueAsDate": "2022-04-13",
"valueSanitized": "string"
}
],
"nameIssues": null,
"nameContainsHtml": true,
"nameAsText": "string",
"selectValuesArray": [
"string"
]
}
],
"entityRoles": null,
"uses": [
"c9d47858-5fe1-4bfa-809f-4c06858c20c8"
],
"user": null,
"createdDate": "2022-04-13T15:42:05.901Z",
"uploadNotificationEmail": "string",
"pages": null,
"taskGroupLinks": null,
"deleted": true,
"watchingUsers": null,
"comments": [
{
"id": 61,
"replyTo": null,
"createdDate": "2022-04-13T15:42:05.901Z",
"user": null,
"contact": null,
"text": "string",
"published": true,
"replies": null,
"notifications": null,
"calendarSource": "PRODUCT",
"hidden": true,
"reply": true,
"greatestAncestor": null,
"replyToIsUnpublished": true,
"serverCreatedReadableDate": "string",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"lastUpdatedById": 187,
"name": "string",
"partition": null,
"display": "string",
"idInPartition": 185,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"calendarExtendedProps": {},
"calendarEnd": "2022-04-13T15:42:05.901Z",
"allDay": true
}
],
"events": null,
"uploadNotifications": [
{
"id": 290,
"partitionId": 185,
"created": "2022-04-13T15:42:05.901Z",
"user": null,
"read": true,
"campaignContactTask": null,
"contact": null,
"fileName": "string",
"baseUrl": "string",
"url": "string",
"mailjetTemplateName": "string",
"displayCode": "string",
"mailjetTemplateVars": {},
"mailjetTemplateEmail": null,
"serverCreatedDate": "2022-04-13T15:42:05.901Z",
"name": "string",
"partition": null,
"display": "string",
"idInPartition": 224,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"surveyNotifications": [
{
"id": 244,
"partitionId": 34,
"created": "2022-04-13T15:42:05.901Z",
"user": null,
"read": true,
"campaignContactTask": null,
"contact": null,
"baseUrl": "string",
"url": "string",
"mailjetTemplateName": "string",
"taskUrl": "string",
"displayCode": "string",
"mailjetTemplateVars": {},
"mailjetTemplateEmail": null,
"serverCreatedDate": "2022-04-13T15:42:05.901Z",
"name": "string",
"partition": null,
"display": "string",
"idInPartition": 247,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"iuclidReviewNotifications": [
{
"id": 12,
"partitionId": 222,
"created": "2022-04-13T15:42:05.901Z",
"user": null,
"read": true,
"campaignContactTask": null,
"contact": null,
"baseUrl": "string",
"url": "string",
"mailjetTemplateName": "string",
"approval": true,
"displayCode": "string",
"mailjetTemplateVars": {},
"mailjetTemplateEmail": null,
"serverCreatedDate": "2022-04-13T15:42:05.901Z",
"name": "string",
"partition": null,
"display": "string",
"idInPartition": 298,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"documentsList": null,
"sendCustomSurveyNotificationEmail": true,
"showDocumentNameOnDownloads": true,
"public": true,
"groups": null,
"archived": true,
"letterOfAccessRelated": true,
"firstActiveDocument": null,
"containingArchivedDocument": true,
"instructionsIssues": null,
"endingInstructionsIssues": null,
"recordName": "string",
"breadcrumbParent": null,
"iconClass": "string",
"webPortalDisplays": "string",
"campaignIfUnrestricted": null,
"firstActiveIuclid": {
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 220,
"partition": null,
"title": "string",
"description": "string",
"fileName": "string",
"originalFileName": "string",
"link": true,
"fileSize": 95,
"uploadDate": "2022-04-13T15:42:05.901Z",
"documentCreationDate": "2022-04-13",
"fileType": "UNKNOWN",
"docType": "DOCUMENT",
"expiryDate": "2022-04-13",
"retentionDate": "2022-04-13",
"permanent": true,
"documentTagSet": null,
"documentContactGroups": null,
"documentEntityGroups": null,
"linkedDocuments": null,
"version": 131,
"versionIdentifier": "string",
"currentDocumentId": 17,
"currentDocument": null,
"newsItem": true,
"deleted": true,
"deletedDate": "2022-04-13T15:42:05.901Z",
"fileId": "4df5d730-8cda-4743-baeb-dd66951a1706",
"watchingUsers": null,
"expiryNotifications": [
{
"id": 150,
"partitionId": 223,
"created": "2022-04-13T15:42:05.901Z",
"user": null,
"read": true,
"document": null,
"expiryDate": "2022-04-13",
"url": "string",
"mailjetTemplateName": "string",
"displayCode": "string",
"mailjetTemplateVars": {},
"daysUntilExpiry": 175,
"drc": true,
"mailjetTemplateEmail": null,
"serverCreatedDate": "2022-04-13T15:42:05.901Z",
"name": "string",
"partition": null,
"display": "string",
"idInPartition": 81,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"retentionNotifications": [
{
"id": 70,
"partitionId": 53,
"created": "2022-04-13T15:42:05.901Z",
"user": null,
"read": true,
"document": null,
"retentionDate": "2022-04-13",
"url": "string",
"mailjetTemplateName": "string",
"displayCode": "string",
"mailjetTemplateVars": {},
"daysUntilExpiry": 67,
"mailjetTemplateEmail": null,
"serverCreatedDate": "2022-04-13T15:42:05.901Z",
"name": "string",
"partition": null,
"display": "string",
"idInPartition": 45,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"notifyEmail": "string",
"expirationNotified": true,
"retentionNotified": true,
"folders": null,
"taskLinks": null,
"taskTwoLinks": null,
"downloadTaskLinks": null,
"constituentTonnages": [
{
"id": 194,
"reachLegislation": "EU_REACH",
"registration": {
"id": 28,
"constituent": null,
"forEntity": null,
"reachLegislation": "EU_REACH",
"legalEntity": null,
"ecName": "string",
"ecNumber": "string",
"submissionNumber": "string",
"registrationNumber": "string",
"registrationName": "string",
"registrationDate": "2022-04-13",
"registrationNotes": "string",
"publicName": "string",
"submissionDate": "2022-04-13",
"uclidID": "string",
"reachRole": "MANUFACTURER",
"reachSubstanceTypeComposition": "MONO_CONSTITUENT",
"substanceTypeCompositionOther": "string",
"reachSubstanceTypeOrigin": "ELEMENT",
"substanceTypeOriginOther": "string",
"originEntity": null,
"onlyRepresentative": null,
"preregistrationName": "string",
"preregistrationNumber": "string",
"preregistrationDate": "2022-04-13",
"preregisteredTonnageBand": "BAND_1",
"notPreregistered": "string",
"exemptionType": "EXEMPTION",
"exemption": "string",
"exemptionClaimed": "string",
"exemptionComment": "string",
"reachITRegistrations": [
{
"id": 215,
"reachRegistration": null,
"dateSubmitted": "2022-04-13",
"dateIssued": "2022-04-13",
"dateAccepted": "2022-04-13",
"reachDossierType": "A",
"tonnageBand": "BAND1",
"reason": "CEASE_OF_MANUFACTURE",
"notes": "string",
"iuclidDossierReference": "string",
"submissionNumber": "string",
"passedPipeline": true,
"supportingDocument": null,
"partitionId": 256,
"constituent": null,
"forEntity": null,
"leadRegistrant": null
}
],
"registeredTonnageBands": [
{
"id": 168,
"reachRegistration": null,
"registeredTonnageBand": "BAND_1",
"start": "2022-04-13",
"url": "string",
"calendarStart": "2022-04-13T15:42:05.901Z",
"allDay": true,
"calendarDisplay": "string",
"calendarSource": "PRODUCT",
"calendarExtendedProps": {},
"calendarEnd": "2022-04-13T15:42:05.901Z",
"name": "string",
"partitionId": 83,
"partition": null,
"display": "string",
"idInPartition": 98,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"preregistered": true,
"enquiryNumber": "string",
"ppordNumber": "string",
"submissionType": "GRANDFATHERED",
"reachDossierType": "A",
"constituentTonnages": null,
"partitionId": 187,
"currentTonnageBandToImport": "BAND_1",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z"
},
"percentage": 10.12,
"constituent": null,
"entryYear": 8,
"forecast": true,
"tonnesOwnProduction": 10.12,
"tonnesOwnImport": 10.12,
"site": null,
"notes": "string",
"enteredDate": "2022-04-13",
"substanceOrUnknown": 10.12,
"monomerInAPolymer": 10.12,
"mixture": 10.12,
"inAnArticle": 10.12,
"notInAnArticle": 10.12,
"document": null,
"user": null,
"lastUpdated": "2022-04-13",
"deleted": true,
"forEntity": null
}
],
"productTonnages": [
{
"id": 283,
"reachLegislation": "EU_REACH",
"forEntity": null,
"product": null,
"entryYear": 258,
"forecast": true,
"notes": "string",
"enteredDate": "2022-04-13",
"substanceOrUnknown": 10.12,
"monomerInAPolymer": 10.12,
"mixture": 10.12,
"inAnArticle": 10.12,
"notInAnArticle": 10.12,
"document": null,
"tonnesManufactured": 10.12,
"tonnesImported": 10.12,
"party": null,
"user": null,
"lastUpdated": "2022-04-13",
"deleted": true
}
],
"comments": [
{
"id": 94,
"replyTo": null,
"createdDate": "2022-04-13T15:42:05.901Z",
"user": null,
"contact": null,
"text": "string",
"published": true,
"replies": null,
"notifications": null,
"node": {
"id": 263,
"code": "string",
"forType": "string",
"title": "string",
"matrix": true,
"children": null,
"records": [
{
"type": "DOCUMENT",
"iuclidVersion": "string",
"key": "string",
"name": "string",
"documentType": "string",
"subType": "string",
"orderInSectionNo": "string",
"definitionVersion": "string",
"creationDate": "2022-04-13T15:42:05.901Z",
"lastModificationDate": "2022-04-13T15:42:05.901Z",
"submissionType": "string",
"submissionTypeVersion": "string",
"submittingLegalEntity": "string",
"dossier": null,
"dossierSubjectKey": "string",
"dossierSubject": null,
"i5Origin": true,
"creationTool": "string",
"snapshotCreationTool": "string",
"href": "string",
"attachments": null,
"literatureDocuments": null,
"otherReferences": null,
"templates": null,
"categories": null,
"records": {},
"tree": null,
"ownerLegalEntity": null,
"refSubstance": null,
"substances": null,
"containerId": "string",
"i6CategoryDocumentDefinitionIdentifiers": [
{
"documentType": "string",
"documentSubType": "string"
}
],
"changeType": "ADDED",
"commentCount": 176,
"descendantComments": true,
"content": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=",
"subject": null,
"definition": "string",
"template": true,
"display": "string",
"uuid": "string",
"category": true,
"creationDateFromString": "string",
"lastModificationDateFromString": "string",
"substance": true,
"idString": "string",
"endpointSummary": true
}
],
"changeType": "ADDED",
"commentCount": 110,
"descendantComments": true,
"display": "string",
"idString": "string"
},
"wrapperId": "string",
"calendarSource": "PRODUCT",
"forTocEntry": true,
"name": "string",
"partition": null,
"display": "string",
"idInPartition": 284,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"hidden": true,
"reply": true,
"greatestAncestor": null,
"replyToIsUnpublished": true,
"serverCreatedReadableDate": "string",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"lastUpdatedById": 174,
"calendarExtendedProps": {},
"calendarEnd": "2022-04-13T15:42:05.901Z",
"allDay": true
}
],
"searchedVia": null,
"integration": {
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 229,
"created": "2022-04-13T15:42:05.901Z",
"type": "BOCOUNT_EXPORT_INVOICES",
"name": "string",
"host": "string",
"principal": "string",
"credential": "string",
"token": "string",
"tokenTransient": "string",
"tokenExpires": "2022-04-13T15:42:05.901Z",
"refreshToken": "string",
"authType": "PLAIN",
"entity": null,
"iuclidDocuments": null,
"display": "string",
"tokenExpired": true,
"tokenEncrypted": "string",
"refreshTokenEncrypted": "string",
"credentialEncrypted": "string",
"refreshTokenExpired": true
},
"IUCLIDAuthor": "string",
"legalEntity": "string",
"creationDate": "2022-04-13",
"uuid": "string",
"context": {
"id": 272,
"provider": "string",
"identifier": "string",
"title": "string",
"applicableFor": "string",
"tree": "string",
"key": "string"
},
"manifest": {
"title": "string",
"created": "2022-04-13T15:42:05.901Z",
"author": "string",
"application": "string",
"submissionTypeString": "string",
"context": null,
"archiveType": "string",
"legislation": {},
"comment": "string",
"baseDocumentUuid": "string",
"baseDocument": null,
"treeName": "string",
"relevantDocumentType": "string"
},
"iuclidauthor": "string",
"index": 241,
"relatedDocumentConstituents": [
{
"id": 229,
"document": null,
"constituent": null,
"deleted": true
}
],
"relatedDocumentContactGroups": null,
"relatedDocumentEntities": [
{
"id": 169,
"entity": null,
"document": null,
"deleted": true
}
],
"relatedDocumentProductGroups": [
{
"id": 88,
"document": null,
"productGroup": {
"groupName": "string",
"partitionId": 134
}
}
],
"relatedDocumentProducts": [
{
"id": 63,
"document": null,
"product": null,
"deleted": true
}
],
"partitionId": 67
},
"commentType": "string",
"commentsPermission": "ROLE_PRE_AUTH",
"commentsEditPermission": "ROLE_PRE_AUTH",
"commentDisplayUrl": "string",
"closed": true,
"watching": true,
"url": "string",
"partitionId": 18,
"partition": null,
"display": "string",
"idInPartition": 75,
"displayAttributes": [
{}
],
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"iconColour": "string"
}
],
"name": "string",
"commentType": "string",
"commentsPermission": "ROLE_PRE_AUTH",
"commentsEditPermission": "ROLE_PRE_AUTH",
"commentDisplayUrl": "string",
"productIds": [
9
],
"constituentIds": [
142
],
"studyIds": [
108
],
"entityIds": [
292
],
"lastUpdatedById": 98,
"url": "string",
"partitionId": 168,
"partition": null,
"display": "string",
"idInPartition": 294,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"emailCode": "string",
"emailPrefix": "string",
"oneToOne": true,
"watching": true
}
],
"documentLinkAttachments": null,
"deleted": true,
"deletedDate": "2022-04-13T15:42:05.901Z",
"fileId": "5b90998e-49ba-4c16-b78e-ba6967653bd4",
"watchingUsers": null,
"expiryNotifications": null,
"retentionNotifications": null,
"notifyEmail": "string",
"expirationNotified": true,
"retentionNotified": true,
"folders": null,
"taskLinks": null,
"taskTwoLinks": null,
"downloadTaskLinks": null,
"constituentTonnages": null,
"productTonnages": null,
"comments": null,
"searchedVia": null,
"emailDate": "2022-04-13T15:42:05.901Z",
"sender": "string",
"recipients": [
{
"id": 259,
"type": "TO",
"firstName": "string",
"secondName": "string",
"emailAddress": "string",
"documentEmailInternal": null,
"contact": null,
"deleted": true,
"fullName": "string"
}
],
"subject": "string",
"emailBody": "string",
"privatise": true,
"fromTemplate": true,
"cc": "string",
"bcc": "string",
"saveAsDraft": true,
"index": 276,
"relatedDocumentConstituents": null,
"relatedDocumentContactGroups": null,
"relatedDocumentEntities": null,
"relatedDocumentProductGroups": null,
"relatedDocumentProducts": null,
"partitionId": 254
}
],
"tonnageAndUseEnquiries": null,
"reminderDatePassed": true
},
"documentEmailInternals": null,
"products": null,
"tonnageAndUseImporters": [
{
"id": 296,
"name": "string",
"address": "string",
"contactPerson": "string",
"email": "string",
"telephone": "string",
"tauiProducts": [
{
"id": 224,
"tonnageAndUseEnquiryProductUses": [
{
"id": 185,
"tonnageAndUseImporter": null,
"useUuid": "ba105d76-47ea-4b3e-8c34-7f96d4cd07aa",
"puStatus": "x",
"usePercentage": 10.12,
"selected": true,
"remarks": "string"
}
],
"customUses": [
{
"id": 206,
"useName": "string",
"useDescription": "string",
"percentage": 10.12,
"tauiProduct": null
}
],
"quantityTonnes": 10.12,
"substanceOrUnknown": 10.12,
"monomerInAPolymer": 10.12,
"mixture": 10.12,
"inAnArticle": 10.12,
"notInAnArticle": 10.12,
"selected": true,
"product": null,
"remarks": "string"
}
],
"clientPartition": null,
"taxID": "string",
"country": "string"
}
],
"tonnageAndUseEnquiryUploadDocuments": [
{
"id": 77,
"fileName": "string",
"fileId": "0d1f2e3d-0dad-4bc2-b4bf-b527b5c93e4c"
}
],
"clientPartition": null,
"id": 162,
"dateCreated": "2022-04-13T15:42:05.901Z",
"code": "string",
"hidden": true,
"submitted": true,
"includeForms": true,
"dateSubmited": "2022-04-13T15:42:05.901Z",
"accepted": true,
"dateAccepted": "2022-04-13T15:42:05.901Z",
"acceptedBy": null,
"submittedBy": null,
"sentBy": null,
"completeWithinDays": 264,
"createdAsTonnageEnquiry": true,
"removeBracketedTextFromProductName": true,
"entityRole": null
}
],
"testingLaboratoryContacts": [
{
"id": 109,
"testingLaboratory": {
"id": 176,
"clientPartition": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdated": "2022-04-13T15:42:05.901Z",
"study": null,
"testingLaboratoryEntity": null,
"contacts": null,
"studyNumbers": [
{
"id": 160,
"testingLaboratory": null,
"activity": "string",
"contractRef": "string",
"studyNumber": "string",
"cost": 10.12,
"publishedCost": 10.12,
"payments": [
{
"id": 51,
"name": "string",
"estimatedDate": "2022-04-13",
"cost": 10.12,
"percentage": 10.12,
"studyNumber": null,
"type": "SCHEDULED",
"yearMonth": {
"year": 230,
"month": "JANUARY",
"monthValue": 298,
"leapYear": true
},
"year": 183,
"budget": {
"id": 264,
"clientPartition": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdated": "2022-04-13T15:42:05.901Z",
"name": "string",
"start": "2022-04-13",
"end": "2022-04-13",
"currency": "string",
"cost": 10.12,
"externalRef": "string",
"description": "string",
"products": null,
"constituents": null,
"categoryGroups": [
{
"id": 60,
"groupName": "string",
"partitionId": 275
}
],
"documentBudgets": [
{
"id": 162,
"document": null,
"budget": null,
"cost": 10.12
}
],
"entityBudgets": [
{
"id": 88,
"entity": null,
"budget": null,
"purchaseOrderNumber": "string",
"constituentEntity": null,
"constituent": null
}
],
"currencyInstance": {
"currencyCode": "string",
"numericCodeAsString": "string",
"displayName": "string",
"symbol": "string",
"defaultFractionDigits": 217,
"numericCode": 50
},
"lastUpdatedById": 56,
"url": "string",
"partitionId": 155,
"partition": null,
"display": "string",
"idInPartition": 3,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
},
"yearQuarter": {
"value": 274,
"key": 116,
"left": 92,
"right": 261
},
"quarter": 44
}
],
"activities": [
{
"id": 155,
"studyNumber": null,
"name": "string",
"autoPlannedAfter": 183,
"autoPlannedAfterPrevious": 125,
"planned": "2022-04-13",
"completed": "2022-04-13",
"signedBy": null,
"editable": true,
"template": {
"id": 102,
"timelineTemplate": {
"id": 284,
"name": "string",
"activityTemplates": null
},
"name": "string",
"autoPlannedAfter": 289,
"autoPlannedAfterPrevious": 200,
"responsible": "CRO",
"activities": null
},
"comments": [
{
"id": 94,
"replyTo": null,
"createdDate": "2022-04-13T15:42:05.901Z",
"user": null,
"contact": null,
"text": "string",
"published": true,
"replies": null,
"notifications": null,
"calendarSource": "PRODUCT",
"hidden": true,
"reply": true,
"greatestAncestor": null,
"replyToIsUnpublished": true,
"serverCreatedReadableDate": "string",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"lastUpdatedById": 144,
"name": "string",
"partition": null,
"display": "string",
"idInPartition": 132,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"calendarExtendedProps": {},
"calendarEnd": "2022-04-13T15:42:05.901Z",
"allDay": true
}
],
"overdueNotifications": [
{
"id": 147,
"partitionId": 179,
"created": "2022-04-13T15:42:05.901Z",
"user": null,
"read": true,
"activity": null,
"planned": "2022-04-13",
"url": "string",
"mailjetTemplateName": "string",
"displayCode": "string",
"mailjetTemplateVars": {},
"mailjetTemplateEmail": null,
"serverCreatedDate": "2022-04-13T15:42:05.901Z",
"name": "string",
"partition": null,
"display": "string",
"idInPartition": 285,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"overdueNotified": true,
"inheritingGroupActivities": [
{
"id": 227,
"group": {
"id": 157,
"clientPartition": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdated": "2022-04-13T15:42:05.901Z",
"name": "string",
"description": "string",
"studies": null,
"entityStudyGroups": [
{
"id": 291,
"entity": null,
"purpose": "VI",
"entityCostRole": {
"id": 99,
"display": "string",
"journal": "MEM_S_CN",
"name": "string",
"url": "string",
"partitionId": 104,
"partition": null,
"idInPartition": 223,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
},
"purchaseOrderNumber": "string",
"constituentEntity": null,
"group": null,
"constituent": null
}
],
"overriddenStudies": null,
"activities": null,
"watchingUsers": null,
"comments": [
{
"id": 157,
"replyTo": null,
"createdDate": "2022-04-13T15:42:05.901Z",
"user": null,
"contact": null,
"text": "string",
"published": true,
"replies": null,
"notifications": null,
"calendarSource": "PRODUCT",
"hidden": true,
"reply": true,
"greatestAncestor": null,
"replyToIsUnpublished": true,
"serverCreatedReadableDate": "string",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"lastUpdatedById": 63,
"name": "string",
"partition": null,
"display": "string",
"idInPartition": 198,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"calendarExtendedProps": {},
"calendarEnd": "2022-04-13T15:42:05.901Z",
"allDay": true
}
],
"studiesCount": 249,
"commentDisplayUrl": "string",
"watching": true,
"commentType": "string",
"commentsPermission": "ROLE_PRE_AUTH",
"commentsEditPermission": "ROLE_PRE_AUTH",
"url": "string",
"partitionId": 92,
"partition": null,
"display": "string",
"idInPartition": 167,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"lastUpdatedById": 60
},
"name": "string",
"planned": "2022-04-13"
}
],
"url": "string",
"partitionId": 256,
"commentCount": 179,
"recordName": "string",
"calendarExtendedProps": {},
"calendarStart": "2022-04-13T15:42:05.901Z",
"allDay": true,
"commentType": "string",
"commentDisplayUrl": "string",
"daysOverdue": 34,
"overdue": true,
"inheritingGroupNames": [
"string"
],
"multipleInheritanceDates": true,
"fromTemplate": true,
"autoPlannedAfterPreviousFallback": 263,
"calendarSource": "PRODUCT",
"calendarEnd": "2022-04-13T15:42:05.901Z",
"partition": null,
"display": "string",
"idInPartition": 37,
"displayAttributes": [
{}
],
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"watching": true,
"commentsPermission": "ROLE_PRE_AUTH",
"commentsEditPermission": "ROLE_PRE_AUTH"
}
],
"emptyCosts": true,
"activityStudyNumber": "string"
}
],
"evaluations": [
{
"id": 182,
"metric": {
"id": 46,
"name": "string"
},
"score": "VERY_POOR"
}
],
"evaluationNotes": "string",
"studyDirectors": null,
"lastUpdatedById": 93,
"name": "string",
"url": "string",
"partitionId": 251,
"partition": null,
"display": "string",
"idInPartition": 164,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
},
"role": {
"id": 97,
"name": "string"
},
"contact": null
}
],
"analyticalSamples": [
{
"id": 115,
"study": null,
"name": "string",
"referenceNumber": "string",
"batchNumber": "string",
"preparation": "2022-04-13",
"expiry": "2022-04-13",
"origin": null,
"contact": null,
"description": "string",
"folder": null,
"notes": "string",
"constituent": null,
"basisOfData": "ANALYTICAL_REPORT",
"analyticalMethods": [
{
"id": 44,
"analyticalSample": null,
"analyticalMethod": "GC"
}
],
"analysis": "2022-04-13",
"linkedDocument": null,
"subConstituents": [
{
"id": 66,
"analyticalSample": null,
"name": "string",
"casNumber": "string",
"ecNumber": "string",
"inclusionPercent": 10.12,
"type": [
{
"id": 3,
"subConstituent": null,
"subConstituentType": {
"id": 232,
"typeText": "string"
},
"ordinalPosition": 254,
"typeText": "string"
}
]
}
],
"studyId": 135,
"analyticalMethodsOnly": [
"GC"
],
"folderName": "string",
"entity": null
}
],
"documentLinks": null,
"contactRecipients": null,
"campaignContacts": null,
"events": null,
"selected": true,
"selectable": true,
"fullName": "string",
"partitionId": 6
},
"text": "string",
"published": true,
"replies": null,
"notifications": null,
"hidden": true,
"reply": true,
"greatestAncestor": null,
"replyToIsUnpublished": true,
"serverCreatedReadableDate": "string",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"lastUpdatedById": 7,
"name": "string",
"partition": null,
"display": "string",
"idInPartition": 222,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"calendarSource": "PRODUCT",
"calendarExtendedProps": {},
"calendarEnd": "2022-04-13T15:42:05.901Z",
"allDay": true
},
"createdDate": "2022-04-13T15:42:05.901Z",
"user": null,
"contact": null,
"text": "string",
"published": true,
"replies": null,
"notifications": null,
"calendarSource": "PRODUCT",
"hidden": true,
"reply": true,
"greatestAncestor": null,
"replyToIsUnpublished": true,
"serverCreatedReadableDate": "string",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"lastUpdatedById": 258,
"name": "string",
"partition": null,
"display": "string",
"idInPartition": 25,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"calendarExtendedProps": {},
"calendarEnd": "2022-04-13T15:42:05.901Z",
"allDay": true
}
],
"groups": null,
"primaryInvoicingContact": null,
"secondaryInvoicingContact": null,
"watchingUsers": null,
"registrationsFor": null,
"partitionId": 110,
"selected": true,
"primaryInvoicingContactToImport": "string",
"secondaryInvoicingContactToImport": "string",
"testContacts": null
},
"role": {
"id": 283,
"name": "string",
"deletable": true,
"permissions": [
"ROLE_PRE_AUTH"
],
"externalGroups": [
"string"
],
"forCampaign": true,
"forInternal": true,
"penmanAdmin": true,
"admin": true
},
"forcePasswordChange": true,
"termsAccepted": true,
"calendarDashboard": true,
"clientPortal": true,
"securityVersion": 128,
"secret": "string",
"initials": "string",
"active": true,
"fullName": "string",
"fullNameSanitized": "string",
"credentialsType": "BASIC",
"entityGroups": null,
"nameReversed": "string",
"temporaryPasswordActive": true,
"lastUpdatedById": 49,
"name": "string",
"url": "string",
"partitionId": 22,
"partition": null,
"display": "string",
"idInPartition": 266,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
},
"partition": null,
"role": null,
"enabled": true,
"currentSelection": true,
"notificationPreferences": {
"allDocumentNotifications": true,
"overdueInvoices": true,
"allCampaignNotifications": true,
"allStudyNotifications": true,
"constituentTonnage": true,
"emails": true,
"constituentsInUpdatedInventories": true,
"campaignSecurityWarnings": true,
"invoicePayments": true
},
"relevantRole": null
}
],
"entities": null,
"emailFolder": null,
"studyFolder": null,
"archivedStudyFolder": null,
"deletedStudyFolder": null,
"studyTimelineTemplate": null,
"studyNumberTimelineTemplate": null,
"studyMultiRegistrantShare": 211,
"defaultCostRoles": null,
"invoiceOverdueDays": 221,
"invoiceTemplate": "string",
"docExpiryNotificationDays": 284,
"countries": null,
"hidden": true,
"pages": null,
"campaignTasks": null,
"campaignImages": [
{
"id": 231,
"clientPartition": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdated": "2022-04-13T15:42:05.901Z",
"campaign": null,
"fileId": "10a70d94-596f-4d7e-93bf-ede197e7dce4",
"fileName": "string",
"lastUpdatedById": 200,
"name": "string",
"url": "string",
"partitionId": 289,
"partition": null,
"display": "string",
"idInPartition": 175,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"integrations": null,
"name": "string",
"campaignNavigationLevel": 1,
"onlyPublicAccessForUser": true,
"expand": true,
"menuIndex": 259,
"recordName": "string",
"acceptInvoiceImport": true,
"studyAdditionalSharePercent": 27,
"menuParent": null,
"menuAncestors": null,
"url": "string",
"partitionId": 9,
"partition": null,
"display": "string",
"idInPartition": 12,
"displayAttributes": [
{}
],
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
},
"title": "string",
"description": "string",
"fileName": "string",
"originalFileName": "string",
"link": true,
"fileSize": 208,
"uploadDate": "2022-04-13T15:42:05.901Z",
"documentCreationDate": "2022-04-13",
"fileType": "UNKNOWN",
"docType": "DOCUMENT",
"expiryDate": "2022-04-13",
"retentionDate": "2022-04-13",
"permanent": true,
"documentEntities": null,
"documentProducts": null,
"documentConstituents": null,
"documentCategoryGroups": [
{
"id": 181,
"document": null,
"categoryGroup": null,
"deleted": true
}
],
"documentProductGroups": null,
"documentTagSet": null,
"documentContactGroups": null,
"documentEntityGroups": null,
"linkedDocuments": null,
"version": 300,
"versionIdentifier": "string",
"currentDocumentId": 7,
"currentDocument": null,
"newsItem": true,
"sourceEmail": [
{
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 286,
"partition": null,
"title": "string",
"description": "string",
"fileName": "string",
"originalFileName": "string",
"link": true,
"fileSize": 297,
"uploadDate": "2022-04-13T15:42:05.901Z",
"documentCreationDate": "2022-04-13",
"fileType": "UNKNOWN",
"docType": "DOCUMENT",
"expiryDate": "2022-04-13",
"retentionDate": "2022-04-13",
"permanent": true,
"documentTagSet": null,
"documentContactGroups": null,
"documentEntityGroups": null,
"linkedDocuments": null,
"version": 211,
"versionIdentifier": "string",
"currentDocumentId": 25,
"currentDocument": null,
"newsItem": true,
"internalSourceEmails": null,
"issues": null,
"documentLinkAttachments": null,
"deleted": true,
"deletedDate": "2022-04-13T15:42:05.901Z",
"fileId": "e9a7ac3f-9b39-4397-a2a2-b3cd18cd74ee",
"watchingUsers": null,
"expiryNotifications": null,
"retentionNotifications": null,
"notifyEmail": "string",
"expirationNotified": true,
"retentionNotified": true,
"folders": null,
"taskLinks": null,
"taskTwoLinks": null,
"downloadTaskLinks": null,
"constituentTonnages": null,
"productTonnages": null,
"comments": null,
"searchedVia": null,
"receivedDate": "2022-04-13T15:42:05.901Z",
"emailDate": "2022-04-13",
"sender": "string",
"subject": "string",
"recipient": "string",
"emailBody": "string",
"ccAddresses": "string",
"missingAttachments": [
{
"id": 76,
"receivedEmail": {
"id": 249,
"subject": "string",
"fromAddress": "string",
"messageRead": true,
"dateReceived": "2022-04-13T15:42:05.901Z",
"dateMessageSaved": "2022-04-13T15:42:05.901Z",
"dateAttachmentsSaved": "2022-04-13T15:42:05.901Z",
"contentType": "string",
"ccAddresses": "string",
"recipients": "string",
"content": "string",
"clientPartition": null,
"deleted": true,
"emailAttachments": null
},
"fileId": "3f45f759-415f-478f-9bcf-5efbd6c20852",
"filename": "string"
}
],
"attachmentsToSave": [
"b2fad725-aa95-445c-926b-3899889cde76"
],
"index": 42,
"relatedDocumentConstituents": null,
"relatedDocumentContactGroups": null,
"relatedDocumentEntities": null,
"relatedDocumentProductGroups": null,
"relatedDocumentProducts": null,
"partitionId": 35
}
],
"internalSourceEmails": null,
"issues": null,
"documentLinkAttachments": null,
"deleted": true,
"deletedDate": "2022-04-13T15:42:05.901Z",
"fileId": "9aebe05a-2b4e-4977-b260-6cacd4ff1465",
"watchingUsers": null,
"expiryNotifications": null,
"retentionNotifications": null,
"notifyEmail": "string",
"expirationNotified": true,
"retentionNotified": true,
"folders": null,
"taskLinks": null,
"taskTwoLinks": null,
"downloadTaskLinks": null,
"constituentTonnages": null,
"productTonnages": null,
"submissions": null,
"comments": null,
"searchedVia": null,
"index": 194,
"relatedDocumentConstituents": null,
"relatedDocumentContactGroups": null,
"relatedDocumentEntities": null,
"relatedDocumentCategoryGroups": null,
"relatedDocumentProductGroups": null,
"relatedDocumentProducts": null,
"partitionId": 107
}
],
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"deletable": true,
"study": null,
"folderPath": "string",
"folderLinks": "string"
},
"partitionId": 288
},
"studies": null,
"constituent": null,
"entity": null,
"entityStudies": [
{
"id": 26,
"entity": null,
"purpose": "VI",
"entityCostRole": null,
"purchaseOrderNumber": "string",
"constituentEntity": null,
"study": null,
"sharedWithOthers": true,
"constituent": null
}
],
"year": 137,
"quarter": 31,
"month": "JANUARY",
"currency": {
"currencyCode": "string",
"numericCodeAsString": "string",
"displayName": "string",
"symbol": "string",
"defaultFractionDigits": 104,
"numericCode": 273
},
"cost": 10.12,
"paid": 10.12,
"costOut": 10.12,
"paidIn": 10.12,
"categoryGroups": null,
"outgoingInvoices": [
{
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 98,
"partition": null,
"title": "string",
"description": "string",
"fileName": "string",
"originalFileName": "string",
"link": true,
"fileSize": 120,
"uploadDate": "2022-04-13T15:42:05.901Z",
"documentCreationDate": "2022-04-13",
"fileType": "UNKNOWN",
"docType": "DOCUMENT",
"expiryDate": "2022-04-13",
"retentionDate": "2022-04-13",
"permanent": true,
"documentEntities": null,
"documentProducts": null,
"documentConstituents": null,
"documentCategoryGroups": null,
"documentProductGroups": null,
"documentTagSet": null,
"documentContactGroups": null,
"documentEntityGroups": null,
"linkedDocuments": null,
"version": 0,
"versionIdentifier": "string",
"currentDocumentId": 85,
"currentDocument": null,
"versions": null,
"newsItem": true,
"sourceEmail": null,
"internalSourceEmails": null,
"issues": null,
"documentLinkAttachments": null,
"deleted": true,
"deletedDate": "2022-04-13T15:42:05.901Z",
"fileId": "b6f69328-458a-453b-8854-c36832f4c63f",
"watchingUsers": null,
"expiryNotifications": null,
"retentionNotifications": null,
"notifyEmail": "string",
"expirationNotified": true,
"retentionNotified": true,
"folders": null,
"taskLinks": null,
"taskTwoLinks": null,
"downloadTaskLinks": null,
"constituentTonnages": null,
"productTonnages": null,
"submissions": null,
"comments": null,
"searchedVia": null,
"fromEntity": null,
"toEntity": null,
"invoiceNumber": "string",
"purchaseOrder": "string",
"accountantReference": "string",
"invoiceDate": "2022-04-13",
"invoiceCurrencyCode": "string",
"documentInvoiceType": "COMMERCIAL",
"legislation": "EU_REACH",
"subTotal": 10.12,
"vat": 10.12,
"invoiceAmount": 10.12,
"paymentReceived": true,
"dateReceived": "2022-04-13",
"approved": true,
"approvedDate": "2022-04-13",
"approvedBy": null,
"sent": true,
"sentDate": "2022-04-13",
"sentBy": null,
"remarks": "string",
"invoiceOverdueDays": 115,
"overdueNotified": true,
"documentBudgets": null,
"documentStudies": [
{
"id": 243,
"document": null,
"study": null,
"cost": 10.12
}
],
"overdueNotifications": [
{
"id": 283,
"partitionId": 255,
"created": "2022-04-13T15:42:05.901Z",
"user": null,
"read": true,
"invoice": null,
"invoiceDate": "2022-04-13",
"invoiceOverdueDays": 296,
"url": "string",
"mailjetTemplateName": "string",
"displayCode": "string",
"mailjetTemplateVars": {},
"mailjetTemplateEmail": null,
"serverCreatedDate": "2022-04-13T15:42:05.901Z",
"name": "string",
"partition": null,
"display": "string",
"idInPartition": 200,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"paidNotifications": [
{
"id": 100,
"partitionId": 150,
"created": "2022-04-13T15:42:05.901Z",
"user": null,
"read": true,
"invoice": null,
"paidDate": "2022-04-13",
"url": "string",
"mailjetTemplateName": "string",
"displayCode": "string",
"mailjetTemplateVars": {},
"mailjetTemplateEmail": null,
"serverCreatedDate": "2022-04-13T15:42:05.901Z",
"name": "string",
"partition": null,
"display": "string",
"idInPartition": 245,
"displayAttributes": [
{}
],
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"lines": [
{
"description": "string",
"amount": 10.12,
"salesCode": "string",
"taxed": true
}
],
"convertedSubTotal": 10.12,
"index": 161,
"relatedDocumentConstituents": null,
"relatedDocumentContactGroups": null,
"relatedDocumentEntities": null,
"relatedDocumentCategoryGroups": null,
"relatedDocumentProductGroups": null,
"relatedDocumentProducts": null,
"partitionId": 174
}
],
"constituentsOfInterest": null,
"constituentsEntities": null,
"monthDisplay": "string",
"reasonsForInterest": [
"string"
],
"registrationNumbers": [
"string"
],
"costRoleDisplays": [
"string"
],
"balanceIn": 10.12,
"purchaseOrderNumbers": [
"string"
],
"costRoles": null,
"balance": 10.12
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/StudyCostOverviewRow"
}
}
Registrations¶
GET /api/registrations/{id}¶
Get a Registration
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 403 Forbidden
Response 200 OK
{
"id": 1,
"constituent": {
"id": 1,
"partitionId": 100,
"name": "Benzene",
"type": "SUBSTANCE",
"casNumber": "100-00-5",
"ecName": "1-chloro-4-nitrobenzene",
"ecNumber": "202-809-6",
"ecDescription": "string",
"iupac": "benzene",
"iuclidUuid": "string",
"tsca": "Benzene, 1-chloro-4-nitro-",
"molecularFormula": "C6H6",
"smiles": "C1=CC=CC=C1",
"inChl": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H",
"deleted": false
},
"reachLegislation": "EU_REACH",
"registrationName": "string",
"registrationNumber": "string",
"registrationDate": "2022-04-13"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"reachLegislation": {
"type": "string",
"enum": [
"EU_REACH",
"K_REACH",
"UK_REACH",
"INDIA_REACH",
"TURKEY_REACH",
"COLOMBIA_REACH",
"NO_REGULATION"
],
"example": "EU_REACH"
},
"registrationName": {
"type": "string"
},
"registrationNumber": {
"type": "string"
},
"registrationDate": {
"type": "string",
"format": "date"
}
},
"required": [
"constituent",
"reachLegislation"
]
}
Response 500 Internal Server Error
Response 404 Not Found
PUT /api/registrations/{id}¶
Fully Update a Registration
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"constituent": {
"id": 1,
"partitionId": 100,
"name": "Benzene",
"type": "SUBSTANCE",
"casNumber": "100-00-5",
"ecName": "1-chloro-4-nitrobenzene",
"ecNumber": "202-809-6",
"ecDescription": "string",
"iupac": "benzene",
"iuclidUuid": "string",
"tsca": "Benzene, 1-chloro-4-nitro-",
"molecularFormula": "C6H6",
"smiles": "C1=CC=CC=C1",
"inChl": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H",
"deleted": false
},
"reachLegislation": "EU_REACH",
"registrationName": "string",
"registrationNumber": "string",
"registrationDate": "2022-04-13"
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"reachLegislation": {
"type": "string",
"enum": [
"EU_REACH",
"K_REACH",
"UK_REACH",
"INDIA_REACH",
"TURKEY_REACH",
"COLOMBIA_REACH",
"NO_REGULATION"
],
"example": "EU_REACH"
},
"registrationName": {
"type": "string"
},
"registrationNumber": {
"type": "string"
},
"registrationDate": {
"type": "string",
"format": "date"
}
},
"required": [
"constituent",
"reachLegislation"
]
}
Response 400 Bad Request
Response 200 OK
{
"id": 1,
"constituent": {
"id": 1,
"partitionId": 100,
"name": "Benzene",
"type": "SUBSTANCE",
"casNumber": "100-00-5",
"ecName": "1-chloro-4-nitrobenzene",
"ecNumber": "202-809-6",
"ecDescription": "string",
"iupac": "benzene",
"iuclidUuid": "string",
"tsca": "Benzene, 1-chloro-4-nitro-",
"molecularFormula": "C6H6",
"smiles": "C1=CC=CC=C1",
"inChl": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H",
"deleted": false
},
"reachLegislation": "EU_REACH",
"registrationName": "string",
"registrationNumber": "string",
"registrationDate": "2022-04-13"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"reachLegislation": {
"type": "string",
"enum": [
"EU_REACH",
"K_REACH",
"UK_REACH",
"INDIA_REACH",
"TURKEY_REACH",
"COLOMBIA_REACH",
"NO_REGULATION"
],
"example": "EU_REACH"
},
"registrationName": {
"type": "string"
},
"registrationNumber": {
"type": "string"
},
"registrationDate": {
"type": "string",
"format": "date"
}
},
"required": [
"constituent",
"reachLegislation"
]
}
Response 403 Forbidden
Response 500 Internal Server Error
Response 404 Not Found
DELETE /api/registrations/{id}¶
Delete a Registration
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 204 No Content
Response 403 Forbidden
Response 500 Internal Server Error
PATCH /api/registrations/{id}¶
Partially Update a Registration
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"constituent": {
"id": 1,
"partitionId": 100,
"name": "Benzene",
"type": "SUBSTANCE",
"casNumber": "100-00-5",
"ecName": "1-chloro-4-nitrobenzene",
"ecNumber": "202-809-6",
"ecDescription": "string",
"iupac": "benzene",
"iuclidUuid": "string",
"tsca": "Benzene, 1-chloro-4-nitro-",
"molecularFormula": "C6H6",
"smiles": "C1=CC=CC=C1",
"inChl": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H",
"deleted": false
},
"reachLegislation": "EU_REACH",
"registrationName": "string",
"registrationNumber": "string",
"registrationDate": "2022-04-13"
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"reachLegislation": {
"type": "string",
"enum": [
"EU_REACH",
"K_REACH",
"UK_REACH",
"INDIA_REACH",
"TURKEY_REACH",
"COLOMBIA_REACH",
"NO_REGULATION"
],
"example": "EU_REACH"
},
"registrationName": {
"type": "string"
},
"registrationNumber": {
"type": "string"
},
"registrationDate": {
"type": "string",
"format": "date"
}
},
"required": [
"constituent",
"reachLegislation"
]
}
Response 400 Bad Request
Response 200 OK
{
"id": 1,
"constituent": {
"id": 1,
"partitionId": 100,
"name": "Benzene",
"type": "SUBSTANCE",
"casNumber": "100-00-5",
"ecName": "1-chloro-4-nitrobenzene",
"ecNumber": "202-809-6",
"ecDescription": "string",
"iupac": "benzene",
"iuclidUuid": "string",
"tsca": "Benzene, 1-chloro-4-nitro-",
"molecularFormula": "C6H6",
"smiles": "C1=CC=CC=C1",
"inChl": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H",
"deleted": false
},
"reachLegislation": "EU_REACH",
"registrationName": "string",
"registrationNumber": "string",
"registrationDate": "2022-04-13"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"reachLegislation": {
"type": "string",
"enum": [
"EU_REACH",
"K_REACH",
"UK_REACH",
"INDIA_REACH",
"TURKEY_REACH",
"COLOMBIA_REACH",
"NO_REGULATION"
],
"example": "EU_REACH"
},
"registrationName": {
"type": "string"
},
"registrationNumber": {
"type": "string"
},
"registrationDate": {
"type": "string",
"format": "date"
}
},
"required": [
"constituent",
"reachLegislation"
]
}
Response 403 Forbidden
Response 500 Internal Server Error
Response 404 Not Found
GET /api/registrations¶
Get all Registrations
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
constituent |
query | integer | No | Filter registrations by constituent | |
page |
query | integer | 0 | No | Zero-based page index (0..N) |
size |
query | integer | 20 | No | The size of the page to be returned |
sort |
query | array | No | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Response 403 Forbidden
Response 200 OK
{
"totalElements": 268,
"totalPages": 250,
"first": true,
"size": 141,
"content": [
{
"id": 1,
"constituent": {
"id": 1,
"partitionId": 100,
"name": "Benzene",
"type": "SUBSTANCE",
"casNumber": "100-00-5",
"ecName": "1-chloro-4-nitrobenzene",
"ecNumber": "202-809-6",
"ecDescription": "string",
"iupac": "benzene",
"iuclidUuid": "string",
"tsca": "Benzene, 1-chloro-4-nitro-",
"molecularFormula": "C6H6",
"smiles": "C1=CC=CC=C1",
"inChl": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H",
"deleted": false
},
"reachLegislation": "EU_REACH",
"registrationName": "string",
"registrationNumber": "string",
"registrationDate": "2022-04-13"
}
],
"number": 194,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"last": true,
"pageable": {
"offset": 60,
"sort": null,
"paged": true,
"unpaged": true,
"pageSize": 10,
"pageNumber": 299
},
"numberOfElements": 141,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RegistrationData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"last": {
"type": "boolean"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"empty": {
"type": "boolean"
}
}
}
POST /api/registrations¶
Create a Registration
Request body
{
"id": 1,
"constituent": {
"id": 1,
"partitionId": 100,
"name": "Benzene",
"type": "SUBSTANCE",
"casNumber": "100-00-5",
"ecName": "1-chloro-4-nitrobenzene",
"ecNumber": "202-809-6",
"ecDescription": "string",
"iupac": "benzene",
"iuclidUuid": "string",
"tsca": "Benzene, 1-chloro-4-nitro-",
"molecularFormula": "C6H6",
"smiles": "C1=CC=CC=C1",
"inChl": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H",
"deleted": false
},
"reachLegislation": "EU_REACH",
"registrationName": "string",
"registrationNumber": "string",
"registrationDate": "2022-04-13"
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"reachLegislation": {
"type": "string",
"enum": [
"EU_REACH",
"K_REACH",
"UK_REACH",
"INDIA_REACH",
"TURKEY_REACH",
"COLOMBIA_REACH",
"NO_REGULATION"
],
"example": "EU_REACH"
},
"registrationName": {
"type": "string"
},
"registrationNumber": {
"type": "string"
},
"registrationDate": {
"type": "string",
"format": "date"
}
},
"required": [
"constituent",
"reachLegislation"
]
}
Response 200 OK
{
"id": 1,
"constituent": {
"id": 1,
"partitionId": 100,
"name": "Benzene",
"type": "SUBSTANCE",
"casNumber": "100-00-5",
"ecName": "1-chloro-4-nitrobenzene",
"ecNumber": "202-809-6",
"ecDescription": "string",
"iupac": "benzene",
"iuclidUuid": "string",
"tsca": "Benzene, 1-chloro-4-nitro-",
"molecularFormula": "C6H6",
"smiles": "C1=CC=CC=C1",
"inChl": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H",
"deleted": false
},
"reachLegislation": "EU_REACH",
"registrationName": "string",
"registrationNumber": "string",
"registrationDate": "2022-04-13"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"reachLegislation": {
"type": "string",
"enum": [
"EU_REACH",
"K_REACH",
"UK_REACH",
"INDIA_REACH",
"TURKEY_REACH",
"COLOMBIA_REACH",
"NO_REGULATION"
],
"example": "EU_REACH"
},
"registrationName": {
"type": "string"
},
"registrationNumber": {
"type": "string"
},
"registrationDate": {
"type": "string",
"format": "date"
}
},
"required": [
"constituent",
"reachLegislation"
]
}
Response 403 Forbidden
Response 500 Internal Server Error
Response 404 Not Found
Products¶
GET /api/products/{id}¶
Get a Product
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"deleted": false
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Lubricant"
},
"ownerManufacturer": {
"type": "string",
"example": "Penman Consulting"
},
"deleted": {
"type": "boolean",
"example": false
}
},
"required": [
"name",
"partitionId"
]
}
Response 404 Not Found
Response 500 Internal Server Error
Response 403 Forbidden
PUT /api/products/{id}¶
Fully Update a Product
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"deleted": false
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Lubricant"
},
"ownerManufacturer": {
"type": "string",
"example": "Penman Consulting"
},
"deleted": {
"type": "boolean",
"example": false
}
},
"required": [
"name",
"partitionId"
]
}
Response 400 Bad Request
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"deleted": false
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Lubricant"
},
"ownerManufacturer": {
"type": "string",
"example": "Penman Consulting"
},
"deleted": {
"type": "boolean",
"example": false
}
},
"required": [
"name",
"partitionId"
]
}
Response 404 Not Found
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/products/{id}¶
Delete a Product
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 204 No Content
Response 403 Forbidden
Response 500 Internal Server Error
PATCH /api/products/{id}¶
Partially Update a Product
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"deleted": false
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Lubricant"
},
"ownerManufacturer": {
"type": "string",
"example": "Penman Consulting"
},
"deleted": {
"type": "boolean",
"example": false
}
},
"required": [
"name",
"partitionId"
]
}
Response 400 Bad Request
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"deleted": false
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Lubricant"
},
"ownerManufacturer": {
"type": "string",
"example": "Penman Consulting"
},
"deleted": {
"type": "boolean",
"example": false
}
},
"required": [
"name",
"partitionId"
]
}
Response 404 Not Found
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/products¶
Get all Products
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
page |
query | integer | 0 | No | Zero-based page index (0..N) |
size |
query | integer | 20 | No | The size of the page to be returned |
sort |
query | array | No | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Response 403 Forbidden
Response 200 OK
{
"totalElements": 209,
"totalPages": 240,
"first": true,
"size": 279,
"content": [
{
"id": 1,
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"deleted": false
}
],
"number": 40,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"last": true,
"pageable": {
"offset": 148,
"sort": null,
"paged": true,
"unpaged": true,
"pageSize": 130,
"pageNumber": 226
},
"numberOfElements": 251,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"last": {
"type": "boolean"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"empty": {
"type": "boolean"
}
}
}
POST /api/products¶
Create a Product
Request body
{
"id": 1,
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"deleted": false
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Lubricant"
},
"ownerManufacturer": {
"type": "string",
"example": "Penman Consulting"
},
"deleted": {
"type": "boolean",
"example": false
}
},
"required": [
"name",
"partitionId"
]
}
Response 400 Bad Request
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"deleted": false
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Lubricant"
},
"ownerManufacturer": {
"type": "string",
"example": "Penman Consulting"
},
"deleted": {
"type": "boolean",
"example": false
}
},
"required": [
"name",
"partitionId"
]
}
Response 404 Not Found
Response 403 Forbidden
Response 500 Internal Server Error
Folders¶
GET /api/folders/{id}¶
Get a Folder
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 404 Not Found
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": {
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": null
}
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Reports"
},
"parent": {
"$ref": "#/components/schemas/FolderData"
}
},
"required": [
"name",
"partitionId"
]
}
Response 403 Forbidden
Response 500 Internal Server Error
PUT /api/folders/{id}¶
Full Update a Folder
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": {
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": null
}
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Reports"
},
"parent": {
"$ref": "#/components/schemas/FolderData"
}
},
"required": [
"name",
"partitionId"
]
}
Response 400 Bad Request
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": {
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": null
}
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Reports"
},
"parent": {
"$ref": "#/components/schemas/FolderData"
}
},
"required": [
"name",
"partitionId"
]
}
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/folders/{id}¶
Delete a Folder
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 204 No Content
Response 500 Internal Server Error
Response 403 Forbidden
PATCH /api/folders/{id}¶
Partially Update a Folder
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": {
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": null
}
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Reports"
},
"parent": {
"$ref": "#/components/schemas/FolderData"
}
},
"required": [
"name",
"partitionId"
]
}
Response 400 Bad Request
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": {
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": null
}
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Reports"
},
"parent": {
"$ref": "#/components/schemas/FolderData"
}
},
"required": [
"name",
"partitionId"
]
}
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/folders¶
Get all Folders
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
page |
query | integer | 0 | No | Zero-based page index (0..N) |
size |
query | integer | 20 | No | The size of the page to be returned |
sort |
query | array | No | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Response 200 OK
{
"totalElements": 222,
"totalPages": 138,
"first": true,
"size": 245,
"content": [
{
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": null
}
],
"number": 300,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"last": true,
"pageable": {
"offset": 203,
"sort": null,
"paged": true,
"unpaged": true,
"pageSize": 293,
"pageNumber": 96
},
"numberOfElements": 253,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FolderData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"last": {
"type": "boolean"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
POST /api/folders¶
Create a Folder
Request body
{
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": {
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": null
}
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Reports"
},
"parent": {
"$ref": "#/components/schemas/FolderData"
}
},
"required": [
"name",
"partitionId"
]
}
Response 400 Bad Request
Response 403 Forbidden
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": {
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": null
}
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Reports"
},
"parent": {
"$ref": "#/components/schemas/FolderData"
}
},
"required": [
"name",
"partitionId"
]
}
Response 500 Internal Server Error
Entities¶
GET /api/entities/{id}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Penman Consulting"
},
"companyNo": {
"type": "string"
},
"vatNo": {
"type": "string"
},
"dunnNo": {
"type": "string"
},
"utr": {
"type": "string"
}
},
"required": [
"name",
"partitionId"
]
}
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
PUT /api/entities/{id}¶
Fully Update a Entity
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Penman Consulting"
},
"companyNo": {
"type": "string"
},
"vatNo": {
"type": "string"
},
"dunnNo": {
"type": "string"
},
"utr": {
"type": "string"
}
},
"required": [
"name",
"partitionId"
]
}
Response 400 Bad Request
Response 403 Forbidden
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Penman Consulting"
},
"companyNo": {
"type": "string"
},
"vatNo": {
"type": "string"
},
"dunnNo": {
"type": "string"
},
"utr": {
"type": "string"
}
},
"required": [
"name",
"partitionId"
]
}
Response 404 Not Found
Response 500 Internal Server Error
DELETE /api/entities/{id}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 204 No Content
Response 403 Forbidden
Response 500 Internal Server Error
PATCH /api/entities/{id}¶
Partially Update a Entity
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Penman Consulting"
},
"companyNo": {
"type": "string"
},
"vatNo": {
"type": "string"
},
"dunnNo": {
"type": "string"
},
"utr": {
"type": "string"
}
},
"required": [
"name",
"partitionId"
]
}
Response 400 Bad Request
Response 403 Forbidden
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Penman Consulting"
},
"companyNo": {
"type": "string"
},
"vatNo": {
"type": "string"
},
"dunnNo": {
"type": "string"
},
"utr": {
"type": "string"
}
},
"required": [
"name",
"partitionId"
]
}
Response 404 Not Found
Response 500 Internal Server Error
GET /api/entities¶
Get all Entities
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
page |
query | integer | 0 | No | Zero-based page index (0..N) |
size |
query | integer | 20 | No | The size of the page to be returned |
sort |
query | array | No | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Response 200 OK
{
"totalElements": 82,
"totalPages": 97,
"first": true,
"size": 155,
"content": [
{
"id": 1,
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string"
}
],
"number": 241,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"last": true,
"pageable": {
"offset": 232,
"sort": null,
"paged": true,
"unpaged": true,
"pageSize": 290,
"pageNumber": 186
},
"numberOfElements": 5,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"last": {
"type": "boolean"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
POST /api/entities¶
Create an Entity
Request body
{
"id": 1,
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Penman Consulting"
},
"companyNo": {
"type": "string"
},
"vatNo": {
"type": "string"
},
"dunnNo": {
"type": "string"
},
"utr": {
"type": "string"
}
},
"required": [
"name",
"partitionId"
]
}
Response 400 Bad Request
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Penman Consulting"
},
"companyNo": {
"type": "string"
},
"vatNo": {
"type": "string"
},
"dunnNo": {
"type": "string"
},
"utr": {
"type": "string"
}
},
"required": [
"name",
"partitionId"
]
}
Response 500 Internal Server Error
Response 403 Forbidden
Constituents¶
GET /api/constituents/{id}¶
Get a Constituent
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 404 Not Found
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "Benzene",
"type": "SUBSTANCE",
"casNumber": "100-00-5",
"ecName": "1-chloro-4-nitrobenzene",
"ecNumber": "202-809-6",
"ecDescription": "string",
"iupac": "benzene",
"iuclidUuid": "string",
"tsca": "Benzene, 1-chloro-4-nitro-",
"molecularFormula": "C6H6",
"smiles": "C1=CC=CC=C1",
"inChl": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H",
"deleted": false
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Benzene"
},
"type": {
"type": "string",
"enum": [
"ACTIVE_INGREDIENT",
"ARTICLE",
"BLEND",
"CO_FORMULANT",
"MIXTURE",
"MONOMER",
"POLYMER",
"SUBSTANCE",
"UN_SPECIFIED"
],
"example": "SUBSTANCE"
},
"casNumber": {
"type": "string",
"example": "100-00-5"
},
"ecName": {
"type": "string",
"example": "1-chloro-4-nitrobenzene"
},
"ecNumber": {
"type": "string",
"example": "202-809-6"
},
"ecDescription": {
"type": "string"
},
"iupac": {
"type": "string",
"example": "benzene"
},
"iuclidUuid": {
"type": "string"
},
"tsca": {
"type": "string",
"example": "Benzene, 1-chloro-4-nitro-"
},
"molecularFormula": {
"type": "string",
"example": "C6H6"
},
"smiles": {
"type": "string",
"example": "C1=CC=CC=C1"
},
"inChl": {
"type": "string",
"example": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H"
},
"deleted": {
"type": "boolean",
"example": false
}
},
"required": [
"name",
"partitionId",
"type"
]
}
Response 500 Internal Server Error
Response 403 Forbidden
PUT /api/constituents/{id}¶
Fully Update a Constituent
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"partitionId": 100,
"name": "Benzene",
"type": "SUBSTANCE",
"casNumber": "100-00-5",
"ecName": "1-chloro-4-nitrobenzene",
"ecNumber": "202-809-6",
"ecDescription": "string",
"iupac": "benzene",
"iuclidUuid": "string",
"tsca": "Benzene, 1-chloro-4-nitro-",
"molecularFormula": "C6H6",
"smiles": "C1=CC=CC=C1",
"inChl": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H",
"deleted": false
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Benzene"
},
"type": {
"type": "string",
"enum": [
"ACTIVE_INGREDIENT",
"ARTICLE",
"BLEND",
"CO_FORMULANT",
"MIXTURE",
"MONOMER",
"POLYMER",
"SUBSTANCE",
"UN_SPECIFIED"
],
"example": "SUBSTANCE"
},
"casNumber": {
"type": "string",
"example": "100-00-5"
},
"ecName": {
"type": "string",
"example": "1-chloro-4-nitrobenzene"
},
"ecNumber": {
"type": "string",
"example": "202-809-6"
},
"ecDescription": {
"type": "string"
},
"iupac": {
"type": "string",
"example": "benzene"
},
"iuclidUuid": {
"type": "string"
},
"tsca": {
"type": "string",
"example": "Benzene, 1-chloro-4-nitro-"
},
"molecularFormula": {
"type": "string",
"example": "C6H6"
},
"smiles": {
"type": "string",
"example": "C1=CC=CC=C1"
},
"inChl": {
"type": "string",
"example": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H"
},
"deleted": {
"type": "boolean",
"example": false
}
},
"required": [
"name",
"partitionId",
"type"
]
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "Benzene",
"type": "SUBSTANCE",
"casNumber": "100-00-5",
"ecName": "1-chloro-4-nitrobenzene",
"ecNumber": "202-809-6",
"ecDescription": "string",
"iupac": "benzene",
"iuclidUuid": "string",
"tsca": "Benzene, 1-chloro-4-nitro-",
"molecularFormula": "C6H6",
"smiles": "C1=CC=CC=C1",
"inChl": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H",
"deleted": false
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Benzene"
},
"type": {
"type": "string",
"enum": [
"ACTIVE_INGREDIENT",
"ARTICLE",
"BLEND",
"CO_FORMULANT",
"MIXTURE",
"MONOMER",
"POLYMER",
"SUBSTANCE",
"UN_SPECIFIED"
],
"example": "SUBSTANCE"
},
"casNumber": {
"type": "string",
"example": "100-00-5"
},
"ecName": {
"type": "string",
"example": "1-chloro-4-nitrobenzene"
},
"ecNumber": {
"type": "string",
"example": "202-809-6"
},
"ecDescription": {
"type": "string"
},
"iupac": {
"type": "string",
"example": "benzene"
},
"iuclidUuid": {
"type": "string"
},
"tsca": {
"type": "string",
"example": "Benzene, 1-chloro-4-nitro-"
},
"molecularFormula": {
"type": "string",
"example": "C6H6"
},
"smiles": {
"type": "string",
"example": "C1=CC=CC=C1"
},
"inChl": {
"type": "string",
"example": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H"
},
"deleted": {
"type": "boolean",
"example": false
}
},
"required": [
"name",
"partitionId",
"type"
]
}
Response 500 Internal Server Error
DELETE /api/constituents/{id}¶
Delete a Constituent
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 204 No Content
Response 403 Forbidden
Response 500 Internal Server Error
PATCH /api/constituents/{id}¶
Partially Update a Constituent
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"partitionId": 100,
"name": "Benzene",
"type": "SUBSTANCE",
"casNumber": "100-00-5",
"ecName": "1-chloro-4-nitrobenzene",
"ecNumber": "202-809-6",
"ecDescription": "string",
"iupac": "benzene",
"iuclidUuid": "string",
"tsca": "Benzene, 1-chloro-4-nitro-",
"molecularFormula": "C6H6",
"smiles": "C1=CC=CC=C1",
"inChl": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H",
"deleted": false
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Benzene"
},
"type": {
"type": "string",
"enum": [
"ACTIVE_INGREDIENT",
"ARTICLE",
"BLEND",
"CO_FORMULANT",
"MIXTURE",
"MONOMER",
"POLYMER",
"SUBSTANCE",
"UN_SPECIFIED"
],
"example": "SUBSTANCE"
},
"casNumber": {
"type": "string",
"example": "100-00-5"
},
"ecName": {
"type": "string",
"example": "1-chloro-4-nitrobenzene"
},
"ecNumber": {
"type": "string",
"example": "202-809-6"
},
"ecDescription": {
"type": "string"
},
"iupac": {
"type": "string",
"example": "benzene"
},
"iuclidUuid": {
"type": "string"
},
"tsca": {
"type": "string",
"example": "Benzene, 1-chloro-4-nitro-"
},
"molecularFormula": {
"type": "string",
"example": "C6H6"
},
"smiles": {
"type": "string",
"example": "C1=CC=CC=C1"
},
"inChl": {
"type": "string",
"example": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H"
},
"deleted": {
"type": "boolean",
"example": false
}
},
"required": [
"name",
"partitionId",
"type"
]
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "Benzene",
"type": "SUBSTANCE",
"casNumber": "100-00-5",
"ecName": "1-chloro-4-nitrobenzene",
"ecNumber": "202-809-6",
"ecDescription": "string",
"iupac": "benzene",
"iuclidUuid": "string",
"tsca": "Benzene, 1-chloro-4-nitro-",
"molecularFormula": "C6H6",
"smiles": "C1=CC=CC=C1",
"inChl": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H",
"deleted": false
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Benzene"
},
"type": {
"type": "string",
"enum": [
"ACTIVE_INGREDIENT",
"ARTICLE",
"BLEND",
"CO_FORMULANT",
"MIXTURE",
"MONOMER",
"POLYMER",
"SUBSTANCE",
"UN_SPECIFIED"
],
"example": "SUBSTANCE"
},
"casNumber": {
"type": "string",
"example": "100-00-5"
},
"ecName": {
"type": "string",
"example": "1-chloro-4-nitrobenzene"
},
"ecNumber": {
"type": "string",
"example": "202-809-6"
},
"ecDescription": {
"type": "string"
},
"iupac": {
"type": "string",
"example": "benzene"
},
"iuclidUuid": {
"type": "string"
},
"tsca": {
"type": "string",
"example": "Benzene, 1-chloro-4-nitro-"
},
"molecularFormula": {
"type": "string",
"example": "C6H6"
},
"smiles": {
"type": "string",
"example": "C1=CC=CC=C1"
},
"inChl": {
"type": "string",
"example": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H"
},
"deleted": {
"type": "boolean",
"example": false
}
},
"required": [
"name",
"partitionId",
"type"
]
}
Response 500 Internal Server Error
GET /api/constituents¶
Get All Constituents
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
page |
query | integer | 0 | No | Zero-based page index (0..N) |
size |
query | integer | 20 | No | The size of the page to be returned |
sort |
query | array | No | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Response 200 OK
{
"totalElements": 198,
"totalPages": 94,
"first": true,
"size": 24,
"content": [
{
"id": 1,
"partitionId": 100,
"name": "Benzene",
"type": "SUBSTANCE",
"casNumber": "100-00-5",
"ecName": "1-chloro-4-nitrobenzene",
"ecNumber": "202-809-6",
"ecDescription": "string",
"iupac": "benzene",
"iuclidUuid": "string",
"tsca": "Benzene, 1-chloro-4-nitro-",
"molecularFormula": "C6H6",
"smiles": "C1=CC=CC=C1",
"inChl": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H",
"deleted": false
}
],
"number": 16,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"last": true,
"pageable": {
"offset": 105,
"sort": null,
"paged": true,
"unpaged": true,
"pageSize": 52,
"pageNumber": 224
},
"numberOfElements": 167,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConstituentData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"last": {
"type": "boolean"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
POST /api/constituents¶
Create a Constituent
Request body
{
"id": 1,
"partitionId": 100,
"name": "Benzene",
"type": "SUBSTANCE",
"casNumber": "100-00-5",
"ecName": "1-chloro-4-nitrobenzene",
"ecNumber": "202-809-6",
"ecDescription": "string",
"iupac": "benzene",
"iuclidUuid": "string",
"tsca": "Benzene, 1-chloro-4-nitro-",
"molecularFormula": "C6H6",
"smiles": "C1=CC=CC=C1",
"inChl": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H",
"deleted": false
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Benzene"
},
"type": {
"type": "string",
"enum": [
"ACTIVE_INGREDIENT",
"ARTICLE",
"BLEND",
"CO_FORMULANT",
"MIXTURE",
"MONOMER",
"POLYMER",
"SUBSTANCE",
"UN_SPECIFIED"
],
"example": "SUBSTANCE"
},
"casNumber": {
"type": "string",
"example": "100-00-5"
},
"ecName": {
"type": "string",
"example": "1-chloro-4-nitrobenzene"
},
"ecNumber": {
"type": "string",
"example": "202-809-6"
},
"ecDescription": {
"type": "string"
},
"iupac": {
"type": "string",
"example": "benzene"
},
"iuclidUuid": {
"type": "string"
},
"tsca": {
"type": "string",
"example": "Benzene, 1-chloro-4-nitro-"
},
"molecularFormula": {
"type": "string",
"example": "C6H6"
},
"smiles": {
"type": "string",
"example": "C1=CC=CC=C1"
},
"inChl": {
"type": "string",
"example": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H"
},
"deleted": {
"type": "boolean",
"example": false
}
},
"required": [
"name",
"partitionId",
"type"
]
}
Response 400 Bad Request
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "Benzene",
"type": "SUBSTANCE",
"casNumber": "100-00-5",
"ecName": "1-chloro-4-nitrobenzene",
"ecNumber": "202-809-6",
"ecDescription": "string",
"iupac": "benzene",
"iuclidUuid": "string",
"tsca": "Benzene, 1-chloro-4-nitro-",
"molecularFormula": "C6H6",
"smiles": "C1=CC=CC=C1",
"inChl": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H",
"deleted": false
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Benzene"
},
"type": {
"type": "string",
"enum": [
"ACTIVE_INGREDIENT",
"ARTICLE",
"BLEND",
"CO_FORMULANT",
"MIXTURE",
"MONOMER",
"POLYMER",
"SUBSTANCE",
"UN_SPECIFIED"
],
"example": "SUBSTANCE"
},
"casNumber": {
"type": "string",
"example": "100-00-5"
},
"ecName": {
"type": "string",
"example": "1-chloro-4-nitrobenzene"
},
"ecNumber": {
"type": "string",
"example": "202-809-6"
},
"ecDescription": {
"type": "string"
},
"iupac": {
"type": "string",
"example": "benzene"
},
"iuclidUuid": {
"type": "string"
},
"tsca": {
"type": "string",
"example": "Benzene, 1-chloro-4-nitro-"
},
"molecularFormula": {
"type": "string",
"example": "C6H6"
},
"smiles": {
"type": "string",
"example": "C1=CC=CC=C1"
},
"inChl": {
"type": "string",
"example": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H"
},
"deleted": {
"type": "boolean",
"example": false
}
},
"required": [
"name",
"partitionId",
"type"
]
}
Response 403 Forbidden
Response 500 Internal Server Error
Submissions¶
GET /api/submissions¶
Get all Submissions
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
constituent |
query | integer | No | Filter submissions by constituent | |
page |
query | integer | 0 | No | Zero-based page index (0..N) |
size |
query | integer | 20 | No | The size of the page to be returned |
sort |
query | array | No | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Response 200 OK
{
"totalElements": 244,
"totalPages": 153,
"first": true,
"size": 290,
"content": [
{
"id": 1,
"registration": {
"id": 1,
"constituent": {
"id": 1,
"partitionId": 100,
"name": "Benzene",
"type": "SUBSTANCE",
"casNumber": "100-00-5",
"ecName": "1-chloro-4-nitrobenzene",
"ecNumber": "202-809-6",
"ecDescription": "string",
"iupac": "benzene",
"iuclidUuid": "string",
"tsca": "Benzene, 1-chloro-4-nitro-",
"molecularFormula": "C6H6",
"smiles": "C1=CC=CC=C1",
"inChl": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H",
"deleted": false
},
"reachLegislation": "EU_REACH",
"registrationName": "string",
"registrationNumber": "string",
"registrationDate": "2022-04-13"
},
"dateSubmitted": "2022-04-13",
"dateIssued": "2022-04-13",
"dateAccepted": "2022-04-13",
"reachDossierType": "A",
"tonnageBand": "BAND3",
"reason": "INITIAL",
"notes": "string",
"iuclidDossierReference": "string",
"submissionNumber": "string"
}
],
"number": 274,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"last": true,
"pageable": {
"offset": 144,
"sort": null,
"paged": true,
"unpaged": true,
"pageSize": 6,
"pageNumber": 213
},
"numberOfElements": 158,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubmissionData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"last": {
"type": "boolean"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
GET /api/submissions/{id}¶
Get a Submission
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"registration": {
"id": 1,
"constituent": {
"id": 1,
"partitionId": 100,
"name": "Benzene",
"type": "SUBSTANCE",
"casNumber": "100-00-5",
"ecName": "1-chloro-4-nitrobenzene",
"ecNumber": "202-809-6",
"ecDescription": "string",
"iupac": "benzene",
"iuclidUuid": "string",
"tsca": "Benzene, 1-chloro-4-nitro-",
"molecularFormula": "C6H6",
"smiles": "C1=CC=CC=C1",
"inChl": "InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H",
"deleted": false
},
"reachLegislation": "EU_REACH",
"registrationName": "string",
"registrationNumber": "string",
"registrationDate": "2022-04-13"
},
"dateSubmitted": "2022-04-13",
"dateIssued": "2022-04-13",
"dateAccepted": "2022-04-13",
"reachDossierType": "A",
"tonnageBand": "BAND3",
"reason": "INITIAL",
"notes": "string",
"iuclidDossierReference": "string",
"submissionNumber": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"registration": {
"$ref": "#/components/schemas/RegistrationData"
},
"dateSubmitted": {
"type": "string",
"format": "date"
},
"dateIssued": {
"type": "string",
"format": "date"
},
"dateAccepted": {
"type": "string",
"format": "date"
},
"reachDossierType": {
"type": "string",
"enum": [
"A",
"B",
"C",
"D",
"E",
"F",
"G",
"H",
"I",
"J",
"K",
"L",
"M",
"N",
"O",
"P",
"Q",
"R",
"S",
"T",
"U",
"V",
"W",
"X",
"Y",
"K_REACH_A",
"K_REACH_B",
"K_REACH_C",
"K_REACH_D",
"K_REACH_E",
"K_REACH_F",
"K_REACH_G",
"K_REACH_H",
"K_REACH_IA",
"K_REACH_IB",
"K_REACH_IC",
"K_REACH_ID",
"K_REACH_IE",
"K_REACH_JA",
"K_REACH_JB",
"K_REACH_JC",
"K_REACH_JD",
"K_REACH_JE",
"K_REACH_KA",
"K_REACH_KB",
"K_REACH_KC",
"K_REACH_KD",
"K_REACH_KE",
"K_REACH_LA",
"K_REACH_LB",
"K_REACH_LC",
"K_REACH_LD",
"K_REACH_LE",
"K_REACH_M",
"K_REACH_N",
"K_REACH_O",
"K_REACH_P"
]
},
"tonnageBand": {
"type": "string",
"enum": [
"BAND1",
"BAND2",
"BAND3",
"BAND4",
"BAND5"
],
"example": "BAND3"
},
"reason": {
"type": "string",
"enum": [
"CEASE_OF_MANUFACTURE",
"GRANDFATHERING",
"INITIAL",
"INQUIRY",
"REQUESTED",
"UPDATE_SPONTANEOUS"
],
"example": "INITIAL"
},
"notes": {
"type": "string"
},
"iuclidDossierReference": {
"type": "string"
},
"submissionNumber": {
"type": "string"
}
},
"required": [
"registration"
]
}
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
DELETE /api/submissions/{id}¶
Delete a Submission
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 204 No Content
Response 403 Forbidden
Response 500 Internal Server Error
Partitions¶
GET /api/partitions¶
Get all Partitions
Response 200 OK
[
{
"id": 1,
"name": "Sandbox",
"email": "sandbox@demo.activesteward.com"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PartitionData"
}
}
Response 403 Forbidden
GET /api/partitions/{id}¶
Get a Partition
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"name": "Sandbox",
"email": "sandbox@demo.activesteward.com"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"name": {
"type": "string",
"example": "Sandbox"
},
"email": {
"type": "string",
"example": "sandbox@demo.activesteward.com"
}
},
"required": [
"email"
]
}
Response 404 Not Found
Response 403 Forbidden
Response 500 Internal Server Error
Formulations¶
GET /api/formulations¶
Get the formulation of a constituent/product
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
constituent |
query | integer | No | ||
product |
query | integer | No |
Response 200 OK
[
{
"id": 1,
"percentage": 3.85,
"parentProduct": 127,
"parentConstituent": 67,
"constituent": 65
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/FormulationData"
}
}
Documents¶
GET /api/documents¶
Get all Documents
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
page |
query | integer | 0 | No | Zero-based page index (0..N) |
size |
query | integer | 20 | No | The size of the page to be returned |
sort |
query | array | No | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Response 200 OK
{
"totalElements": 165,
"totalPages": 192,
"first": true,
"size": 109,
"content": [
{
"id": 1,
"partitionId": 100,
"name": "2025-31-01 Benzene CSR",
"type": "CSR",
"documentCreationDate": "2025-31-01"
}
],
"number": 259,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"last": true,
"pageable": {
"offset": 119,
"sort": null,
"paged": true,
"unpaged": true,
"pageSize": 101,
"pageNumber": 25
},
"numberOfElements": 65,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"last": {
"type": "boolean"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
GET /api/documents/{id}¶
Get a Document
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 404 Not Found
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "2025-31-01 Benzene CSR",
"type": "CSR",
"documentCreationDate": "2025-31-01"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "2025-31-01 Benzene CSR"
},
"type": {
"type": "string",
"enum": [
"DOCUMENT",
"ANALYTICAL_REPORT",
"CJD",
"CONTRACT",
"CWA",
"CSR",
"DU",
"DRC_CONSTITUENT",
"DRC",
"GENDOC",
"INVOICE",
"IUCLID",
"MEET",
"INTERNAL_EMAIL",
"EMAIL",
"GENERIC_EMAIL",
"REPORT",
"RSC",
"SAFETY"
],
"example": "CSR"
},
"documentCreationDate": {
"type": "string",
"format": "date",
"example": "2025-31-01"
}
},
"required": [
"documentCreationDate",
"name",
"partitionId",
"type"
]
}
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/documents/{id}¶
Delete a Document
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 204 No Content
Response 403 Forbidden
Response 500 Internal Server Error
Contacts¶
GET /api/contacts¶
Get All Contacts
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
page |
query | integer | 0 | No | Zero-based page index (0..N) |
size |
query | integer | 20 | No | The size of the page to be returned |
sort |
query | array | No | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Response 200 OK
{
"totalElements": 201,
"totalPages": 69,
"first": true,
"size": 110,
"content": [
{
"id": 1,
"partitionId": 100,
"title": "MR",
"firstName": "James",
"lastName": "Smith",
"nameSuffix": "MR",
"jobDescription": "Environmental Scientist",
"email": "john.smith@example.com",
"telephone": "string",
"fax": "string",
"mobile": "string",
"skype": "string"
}
],
"number": 77,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"last": true,
"pageable": {
"offset": 112,
"sort": null,
"paged": true,
"unpaged": true,
"pageSize": 13,
"pageNumber": 49
},
"numberOfElements": 245,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"last": {
"type": "boolean"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
GET /api/contacts/{id}¶
Get a Contact
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"partitionId": 100,
"title": "MR",
"firstName": "James",
"lastName": "Smith",
"nameSuffix": "MR",
"jobDescription": "Environmental Scientist",
"email": "john.smith@example.com",
"telephone": "string",
"fax": "string",
"mobile": "string",
"skype": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"title": {
"type": "string",
"enum": [
"MR",
"MISS",
"MRS",
"MS",
"DR",
"PROF"
],
"example": "MR"
},
"firstName": {
"type": "string",
"example": "James"
},
"lastName": {
"type": "string",
"example": "Smith"
},
"nameSuffix": {
"type": "string",
"example": "MR"
},
"jobDescription": {
"type": "string",
"example": "Environmental Scientist"
},
"email": {
"type": "string",
"example": "john.smith@example.com"
},
"telephone": {
"type": "string"
},
"fax": {
"type": "string"
},
"mobile": {
"type": "string"
},
"skype": {
"type": "string"
}
},
"required": [
"email",
"firstName",
"lastName",
"partitionId"
]
}
Response 404 Not Found
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/contacts/{id}¶
Delete a Contact
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 204 No Content
Response 403 Forbidden
Response 500 Internal Server Error
Budgets¶
GET /api/budgets¶
Get all Budgets
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
page |
query | integer | 0 | No | Zero-based page index (0..N) |
size |
query | integer | 20 | No | The size of the page to be returned |
sort |
query | array | No | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Response 200 OK
{
"totalElements": 81,
"totalPages": 184,
"first": true,
"size": 185,
"content": [
{
"id": 1,
"partitionId": 100,
"name": "Project Delta",
"start": "2025-01-01",
"end": "2025-31-03",
"currency": "EUR",
"cost": 20000,
"externalRef": "P0088",
"description": "Budget for our 2025 'Delta' project. Costs to be shared amongst member companies"
}
],
"number": 267,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"last": true,
"pageable": {
"offset": 223,
"sort": null,
"paged": true,
"unpaged": true,
"pageSize": 64,
"pageNumber": 223
},
"numberOfElements": 148,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BudgetData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"last": {
"type": "boolean"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
GET /api/budgets/{id}¶
Get a Budget
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "Project Delta",
"start": "2025-01-01",
"end": "2025-31-03",
"currency": "EUR",
"cost": 20000,
"externalRef": "P0088",
"description": "Budget for our 2025 'Delta' project. Costs to be shared amongst member companies"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"type": "string",
"example": "Project Delta"
},
"start": {
"type": "string",
"format": "date",
"example": "2025-01-01"
},
"end": {
"type": "string",
"format": "date",
"example": "2025-31-03"
},
"currency": {
"type": "string",
"example": "EUR"
},
"cost": {
"type": "number",
"example": 20000
},
"externalRef": {
"type": "string",
"example": "P0088"
},
"description": {
"type": "string",
"example": "Budget for our 2025 'Delta' project. Costs to be shared amongst member companies"
}
},
"required": [
"cost",
"partitionId"
]
}
Response 404 Not Found
Response 500 Internal Server Error
Response 403 Forbidden
DELETE /api/budgets/{id}¶
Delete a Budget
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 204 No Content
Response 403 Forbidden
Response 500 Internal Server Error
Schemas¶
AnalyticalSample¶
| Name | Type |
|---|---|
analysis |
string(date) |
analyticalMethods |
Array<AnalyticalSampleAnalyticalMethod> |
analyticalMethodsOnly |
Array<string> |
basisOfData |
string |
batchNumber |
string |
constituent |
Constituent |
contact |
Contact |
description |
string |
entity |
BaseEntity |
expiry |
string(date) |
folder |
Folder |
folderName |
string |
id |
integer(int64) |
linkedDocument |
Document |
name |
string |
notes |
string |
origin |
Party |
preparation |
string(date) |
referenceNumber |
string |
study |
Study |
studyId |
integer(int64) |
subConstituents |
Array<AnalyticalSampleSubConstituent> |
AnalyticalSampleAnalyticalMethod¶
| Name | Type |
|---|---|
analyticalMethod |
string |
analyticalSample |
AnalyticalSample |
id |
integer(int64) |
AnalyticalSampleOrderedSubConstituentTypeReference¶
| Name | Type |
|---|---|
id |
integer(int64) |
ordinalPosition |
integer(int64) |
subConstituent |
AnalyticalSampleSubConstituent |
subConstituentType |
AnalyticalSampleSubConstituentType |
typeText |
string |
AnalyticalSampleSubConstituent¶
| Name | Type |
|---|---|
analyticalSample |
AnalyticalSample |
casNumber |
string |
ecNumber |
string |
id |
integer(int64) |
inclusionPercent |
number(double) |
name |
string |
type |
Array<AnalyticalSampleOrderedSubConstituentTypeReference> |
AnalyticalSampleSubConstituentType¶
| Name | Type |
|---|---|
id |
integer(int64) |
typeText |
string |
BaseEntity¶
| Name | Type |
|---|---|
clientPartitionId |
integer(int64) |
comments |
Array<EntityComment> |
companyNo |
string |
deleted |
boolean |
dunnNo |
string |
entityEntityGroups |
Array<EntityEntityGroup> |
groups |
Array<EntityGroup> |
hasInvoicingAddress |
boolean |
id |
integer(int64) |
invoiceOverdueDays |
integer(int64) |
lastUpdated |
string(date-time) |
name |
string |
partitionId |
integer(int64) |
primaryInvoicingContact |
Contact |
primaryInvoicingContactToImport |
string |
reachID |
string |
registrationsFor |
Array<ReachRegistration> |
remarks |
string |
sapBusinessReference |
string |
secondaryInvoicingContact |
Contact |
secondaryInvoicingContactToImport |
string |
selected |
boolean |
testContacts |
Array<Contact> |
uclidID |
string |
utr |
string |
vatNo |
string |
version |
integer(int32) |
watchingUsers |
Array<User> |
Budget¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
categoryGroups |
Array<CategoryGroup> |
clientPartition |
ClientPartition |
constituents |
Array<Constituent> |
cost |
number |
created |
string(date-time) |
currency |
string |
currencyInstance |
Properties: currencyCode, numericCodeAsString, displayName, symbol, defaultFractionDigits, numericCode |
description |
string |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
documentBudgets |
Array<DocumentBudget> |
end |
string(date) |
entityBudgets |
Array<EntityBudget> |
externalRef |
string |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedById |
integer(int64) |
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
products |
Array<Product> |
recordName |
string |
start |
string(date) |
url |
string |
BudgetData¶
| Name | Type |
|---|---|
cost |
number |
currency |
string |
description |
string |
end |
string(date) |
externalRef |
string |
id |
integer(int64) |
name |
string |
partitionId |
integer(int64) |
start |
string(date) |
Campaign¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
campaignEvents |
Array<CampaignEvent> |
campaignNavigationLevel |
integer(int32) |
clientPartition |
ClientPartition |
closed |
boolean |
contacts |
Array<CampaignContact> |
deleted |
boolean |
description |
string |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
emailCode |
string |
emailPrefix |
string |
endDate |
string(date) |
expand |
boolean |
footerAddress |
string |
footerLink |
string |
footerPhone |
string |
footerPresent |
boolean |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
menuAncestors |
Array<CampaignMenuDisplayable> |
menuIndex |
integer(int32) |
menuName |
string |
menuParent |
CampaignMenuDisplayable |
name |
string |
oneToOne |
boolean |
onlyPublicAccessForUser |
boolean |
pages |
Array<CampaignPage> |
partition |
ClientPartition |
partitionId |
integer(int64) |
recordName |
string |
roles |
Array<CampaignRole> |
section |
CampaignSection |
sections |
Array<CampaignSection> |
securityIssueNotifications |
Array<NotificationCampaignSecurityIssue> |
startDate |
string(date) |
taskGroups |
Array<CampaignContactTaskGroup> |
tasks |
Array<CampaignContactTask> |
termsAndConditionsText |
string |
uploadingLock |
boolean |
url |
string |
visible |
boolean |
watching |
boolean |
watchingUsers |
Array<User> |
CampaignContact¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
campaign |
Campaign |
clientPartition |
ClientPartition |
contact |
Contact |
deleted |
boolean |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
email |
string |
firstName |
string |
fullName |
string |
fullNameFallback |
string |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastLoggedIn |
string(date-time) |
lastName |
string |
name |
string |
pages |
Array<CampaignPage> |
partition |
ClientPartition |
partitionId |
integer(int64) |
recordName |
string |
roles |
Array<CampaignRole> |
tasks |
Array<CampaignContactTask> |
url |
string |
user |
User |
CampaignContactEvent¶
| Name | Type |
|---|---|
allDay |
boolean |
breadcrumbParent |
Displayable |
calendarDisplay |
string |
calendarEnd |
string(date-time) |
calendarExtendedProps |
|
calendarSource |
string |
calendarStart |
string(date-time) |
campaign |
Campaign |
clientPartition |
ClientPartition |
completed |
boolean |
contact |
Contact |
deleted |
boolean |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
documentDates |
Array<DocumentDate> |
downloadedDocumentIds |
Array<integer(int64)> |
downloadedOldDocumentsOf |
Array<integer(int64)> |
eventDate |
string(date-time) |
fileId |
string(uuid) |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
recordName |
string |
responses |
Array<SurveyFieldValue> |
responsesDeleted |
boolean |
surveyValues |
Array<SurveyValue> |
task |
CampaignContactTask |
url |
string |
useSurvey |
UseSurvey |
CampaignContactTask¶
| Name | Type |
|---|---|
access |
string |
archived |
boolean |
breadcrumbParent |
Displayable |
campaign |
Campaign |
campaignContact |
CampaignContact |
campaignIfUnrestricted |
Campaign |
clientPartition |
ClientPartition |
closed |
boolean |
closesOnDate |
string(date) |
commentDisplayUrl |
string |
comments |
Array<CampaignTaskComment> |
commentsEditPermission |
string |
commentsPermission |
string |
commentType |
string |
constituent |
Constituent |
containingArchivedDocument |
boolean |
createdDate |
string(date-time) |
deleted |
boolean |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
document |
Document |
documentLinks |
Array<CampaignContactTaskDocument> |
documentsList |
Array<Document> |
documentTwo |
Document |
dueByDate |
string(date) |
endingInstructions |
string |
endingInstructionsIssues |
Array<SecurityIssue> |
entityRoles |
Array<EntityRole> |
events |
Array<CampaignContactEvent> |
firstActiveDocument |
Document |
firstActiveIuclid |
DocumentIUCLIDOutput |
groups |
Array<CampaignContactTaskGroup> |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
instructions |
string |
instructionsIssues |
Array<SecurityIssue> |
iuclidReviewNotifications |
Array<NotificationIuclidReview> |
letterOfAccessRelated |
boolean |
name |
string |
pages |
Array<CampaignPage> |
partition |
ClientPartition |
partitionId |
integer(int64) |
public |
boolean |
recordName |
string |
role |
CampaignRole |
sendCustomSurveyNotificationEmail |
boolean |
showDocumentNameOnDownloads |
boolean |
surveyFields |
Array<SurveyField> |
surveyNotifications |
Array<NotificationCampaignSurvey> |
taskGroupLinks |
Array<TaskGroupTask> |
taskType |
string |
template |
CampaignTaskTemplate |
uploadNotificationEmail |
string |
uploadNotifications |
Array<NotificationCampaignUpload> |
url |
string |
user |
User |
uses |
Array<string(uuid)> |
watching |
boolean |
watchingUsers |
Array<User> |
webPortalDisplays |
string |
CampaignContactTaskDocument¶
| Name | Type |
|---|---|
campaign |
Campaign |
document |
Document |
id |
CampaignContactTaskDocumentId |
index |
integer(int32) |
task |
CampaignContactTask |
CampaignContactTaskDocumentId¶
| Name | Type |
|---|---|
document |
Document |
documentId |
integer(int64) |
documentPartitionId |
integer(int64) |
taskId |
integer(int64) |
CampaignContactTaskGroup¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
campaign |
Campaign |
clientPartition |
ClientPartition |
description |
string |
descriptionContainsHtml |
boolean |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
name |
string |
pages |
Array<CampaignPageTaskGroup> |
partition |
ClientPartition |
partitionId |
integer(int64) |
recordName |
string |
taskLinks |
Array<TaskGroupTask> |
url |
string |
CampaignEvent¶
| Name | Type |
|---|---|
campaign |
Campaign |
campaignContacts |
Array<CampaignContact> |
displayName |
string |
eventTime |
string(date-time) |
id |
integer(int64) |
CampaignImage¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
campaign |
Campaign |
clientPartition |
ClientPartition |
created |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
fileId |
string(uuid) |
fileName |
string |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedById |
integer(int64) |
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
recordName |
string |
url |
string |
CampaignMenuDisplayable¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
campaignNavigationLevel |
integer(int32) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
expand |
boolean |
iconClass |
string |
iconColour |
string |
id |
|
idInPartition |
integer(int64) |
menuAncestors |
Array<CampaignMenuDisplayable> |
menuIndex |
integer(int32) |
menuParent |
CampaignMenuDisplayable |
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
recordName |
string |
url |
string |
CampaignPage¶
| Name | Type |
|---|---|
access |
string |
activeEntities |
Array<BaseEntity> |
allFields |
string |
allUsers |
boolean |
ancestorsString |
string |
archived |
boolean |
associatedToArchivedContact |
boolean |
campaignContacts |
Array<CampaignContact> |
campaignNavigationLevel |
integer(int32) |
caretPosition |
string |
clientPartition |
ClientPartition |
constituent |
Constituent |
contact |
Contact |
content |
string |
created |
string(date-time) |
cutOffDate |
string(date) |
deleted |
boolean |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
docType |
string |
entities |
Array<BaseEntity> |
entity |
BaseEntity |
entityGroup |
EntityGroup |
expand |
boolean |
hidden |
boolean |
highestSection |
CampaignSection |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
index |
integer(int32) |
invoicePageInfo |
InvoicePageInfo |
issues |
Array<SecurityIssue> |
lastUpdated |
string(date-time) |
lastUpdatedById |
integer(int64) |
membersUrl |
string |
menuAncestors |
Array<CampaignMenuDisplayable> |
menuIndex |
integer(int32) |
menuParent |
CampaignMenuDisplayable |
name |
string |
nameWithSections |
string |
notifications |
Array<NotificationPageChange> |
partition |
ClientPartition |
partitionId |
integer(int64) |
public |
boolean |
recordName |
string |
roles |
Array<CampaignRole> |
sections |
Array<CampaignSection> |
source |
string |
tags |
Array<Tag> |
task |
CampaignContactTask |
type |
string |
url |
string |
visible |
boolean |
CampaignPageTaskGroup¶
| Name | Type |
|---|---|
cutOffDate |
string(date) |
id |
integer(int64) |
index |
integer(int32) |
page |
CampaignPage |
taskGroup |
CampaignContactTaskGroup |
CampaignRole¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
campaign |
Campaign |
campaignContacts |
Array<CampaignContact> |
clientPartition |
ClientPartition |
contactCount |
integer(int32) |
description |
string |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
inUse |
boolean |
name |
string |
pages |
Array<CampaignPage> |
partition |
ClientPartition |
partitionId |
integer(int64) |
recordName |
string |
tabCount |
integer(int32) |
taskCount |
integer(int32) |
tasks |
Array<CampaignContactTask> |
url |
string |
CampaignSection¶
| Name | Type |
|---|---|
allPages |
Array<CampaignPage> |
ancestorsString |
string |
breadcrumbParent |
Displayable |
campaign |
Campaign |
campaignNavigationLevel |
integer(int32) |
children |
Array<CampaignSection> |
clientPartition |
ClientPartition |
constituent |
Constituent |
created |
string(date-time) |
deleted |
boolean |
descendants |
Array<CampaignSection> |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
expand |
boolean |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedById |
integer(int64) |
menuAncestors |
Array<CampaignMenuDisplayable> |
menuIndex |
integer(int32) |
menuParent |
CampaignMenuDisplayable |
name |
string |
pages |
Array<CampaignPage> |
parentSection |
CampaignSection |
partition |
ClientPartition |
partitionId |
integer(int64) |
recordName |
string |
updateOptions |
UpdateOptions |
url |
string |
CampaignTaskComment¶
| Name | Type |
|---|---|
allDay |
boolean |
breadcrumbParent |
Displayable |
calendarEnd |
string(date-time) |
calendarExtendedProps |
|
calendarSource |
string |
contact |
Contact |
createdDate |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
greatestAncestor |
Comment |
hidden |
boolean |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
User |
lastUpdatedById |
integer(int64) |
name |
string |
notifications |
Array<NotificationComment> |
partition |
ClientPartition |
published |
boolean |
recordName |
string |
replies |
Array<Comment> |
reply |
boolean |
replyTo |
Comment |
replyToIsUnpublished |
boolean |
serverCreatedReadableDate |
string |
text |
string |
user |
User |
CampaignTaskTemplate¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
campaign |
Campaign |
clientPartition |
ClientPartition |
created |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
endingInstructions |
string |
fields |
Array<SurveyFieldTemplate> |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
instructions |
string |
lastUpdated |
string(date-time) |
lastUpdatedById |
integer(int64) |
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
recordName |
string |
type |
string |
url |
string |
CategoryGroup¶
| Name | Type |
|---|---|
groupName |
string |
id |
integer(int64) |
partitionId |
integer(int64) |
ClientPartition¶
| Name | Type |
|---|---|
acceptInvoiceImport |
boolean |
archivedStudyFolder |
Folder |
breadcrumbParent |
Displayable |
campaignImages |
Array<CampaignImage> |
campaignNavigationLevel |
integer(int32) |
campaignTasks |
Array<CampaignContactTask> |
countries |
Array<Country> |
defaultCostRoles |
Array<EntityCostRole> |
deletedStudyFolder |
Folder |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
docExpiryNotificationDays |
integer(int32) |
email |
string |
emailFolder |
Folder |
entities |
Array<BaseEntity> |
expand |
boolean |
hidden |
boolean |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
integrations |
Array<Integration> |
invoiceOverdueDays |
integer(int64) |
invoiceTemplate |
string |
logoID |
string(uuid) |
menuAncestors |
Array<CampaignMenuDisplayable> |
menuIndex |
integer(int32) |
menuParent |
CampaignMenuDisplayable |
name |
string |
onlyPublicAccessForUser |
boolean |
pages |
Array<CampaignPage> |
partition |
ClientPartition |
partitionId |
integer(int64) |
partitionName |
string |
recordName |
string |
studyAdditionalSharePercent |
integer(int32) |
studyFolder |
Folder |
studyMultiRegistrantShare |
integer(int32) |
studyNumberTimelineTemplate |
StudyTimelineTemplate |
studyTimelineTemplate |
StudyTimelineTemplate |
url |
string |
userPartitions |
Array<UserPartition> |
Comment¶
| Name | Type |
|---|---|
allDay |
boolean |
breadcrumbParent |
Displayable |
calendarEnd |
string(date-time) |
calendarExtendedProps |
|
calendarSource |
string |
contact |
Contact |
createdDate |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
greatestAncestor |
Comment |
hidden |
boolean |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
User |
lastUpdatedById |
integer(int64) |
name |
string |
notifications |
Array<NotificationComment> |
partition |
ClientPartition |
published |
boolean |
recordName |
string |
replies |
Array<Comment> |
reply |
boolean |
replyTo |
Comment |
replyToIsUnpublished |
boolean |
serverCreatedReadableDate |
string |
text |
string |
user |
User |
Commentable¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
commentDisplayUrl |
string |
comments |
Array<Comment> |
commentsEditPermission |
string |
commentsPermission |
string |
commentType |
string |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
iconClass |
string |
iconColour |
string |
id |
|
idInPartition |
integer(int64) |
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
recordName |
string |
url |
string |
watching |
boolean |
watchingUsers |
Array<User> |
Constituent¶
| Name | Type |
|---|---|
archived |
boolean |
casNumber |
string |
ecDescription |
string |
ecName |
string |
ecNumber |
string |
id |
integer(int64) |
inChl |
string |
iuclidUuid |
string |
iupac |
string |
molecularFormula |
string |
name |
string |
partitionId |
integer(int64) |
smiles |
string |
tsca |
string |
type |
string |
ConstituentContact¶
| Name | Type |
|---|---|
constituent |
Constituent |
contact |
Contact |
contactType |
string |
deleted |
boolean |
id |
integer(int64) |
ConstituentData¶
| Name | Type |
|---|---|
casNumber |
string |
deleted |
boolean |
ecDescription |
string |
ecName |
string |
ecNumber |
string |
id |
integer(int64) |
inChl |
string |
iuclidUuid |
string |
iupac |
string |
molecularFormula |
string |
name |
string |
partitionId |
integer(int64) |
smiles |
string |
tsca |
string |
type |
string |
ConstituentEntity¶
| Name | Type |
|---|---|
constituent |
Constituent |
entity |
BaseEntity |
entityRoles |
Array<EntityRole> |
id |
integer(int64) |
partitionId |
integer(int64) |
ConstituentEntityContact¶
| Name | Type |
|---|---|
constituentEntity |
ConstituentEntity |
contact |
Contact |
deleted |
boolean |
id |
integer(int64) |
ConstituentParty¶
| Name | Type |
|---|---|
constituent |
Constituent |
deleted |
boolean |
id |
integer(int64) |
party |
Party |
ConstituentPartyContact¶
| Name | Type |
|---|---|
constituentParty |
ConstituentParty |
contact |
Contact |
deleted |
boolean |
id |
integer(int64) |
ConstituentPlant¶
| Name | Type |
|---|---|
constituent |
Constituent |
id |
integer(int64) |
plant |
Plant |
ConstituentTonnage¶
| Name | Type |
|---|---|
constituent |
Constituent |
deleted |
boolean |
document |
Document |
enteredDate |
string(date) |
entryYear |
integer(int32) |
forecast |
boolean |
forEntity |
BaseEntity |
id |
integer(int64) |
inAnArticle |
number(double) |
lastUpdated |
string(date) |
mixture |
number(double) |
monomerInAPolymer |
number(double) |
notes |
string |
notInAnArticle |
number(double) |
percentage |
number(double) |
reachLegislation |
string |
registration |
ReachRegistration |
site |
Party |
substanceOrUnknown |
number(double) |
tonnesOwnImport |
number(double) |
tonnesOwnProduction |
number(double) |
user |
User |
Contact¶
| Name | Type |
|---|---|
analyticalSamples |
Array<AnalyticalSample> |
campaignContacts |
Array<CampaignContact> |
constituentContacts |
Array<ConstituentContact> |
constituentEntityContacts |
Array<ConstituentEntityContact> |
constituentPartyContacts |
Array<ConstituentPartyContact> |
contactGroups |
Array<ContactContactGroup> |
contactRecipients |
Array<ContactRecipient> |
deleted |
boolean |
documentLinks |
Array<DocumentLink> |
email |
string |
events |
Array<CampaignContactEvent> |
fax |
string |
firstName |
string |
fullName |
string |
id |
integer(int64) |
jobDescription |
string |
lastName |
string |
lastUpdated |
string(date-time) |
mobile |
string |
nameSuffix |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
primaryInvoicingEntities |
Array<BaseEntity> |
productContacts |
Array<ProductContact> |
productEntityContacts |
Array<ProductEntityContact> |
productPartyContacts |
Array<ProductPartyContact> |
reachIt |
boolean |
remarks |
string |
secondaryInvoicingEntities |
Array<BaseEntity> |
selectable |
boolean |
selected |
boolean |
skype |
string |
telephone |
string |
testingLaboratoryContacts |
Array<TestingLaboratoryContact> |
title |
string |
tonnageAndUseEnquiries |
Array<TonnageAndUseEnquiry> |
user |
User |
ContactContactGroup¶
| Name | Type |
|---|---|
contact |
Contact |
contactGroup |
ContactGroup |
deleted |
boolean |
id |
integer(int64) |
ContactData¶
| Name | Type |
|---|---|
email |
string |
fax |
string |
firstName |
string |
id |
integer(int64) |
jobDescription |
string |
lastName |
string |
mobile |
string |
nameSuffix |
string |
partitionId |
integer(int64) |
skype |
string |
telephone |
string |
title |
string |
ContactGroup¶
| Name | Type |
|---|---|
groupName |
string |
ContactRecipient¶
| Name | Type |
|---|---|
contact |
Contact |
deleted |
boolean |
documentEmailInternal |
DocumentEmailInternal |
emailAddress |
string |
firstName |
string |
fullName |
string |
id |
integer(int64) |
secondName |
string |
type |
string |
Country¶
| Name | Type |
|---|---|
id |
integer(int64) |
iso3166alpha2CountryCode |
string |
iso3166alpha3CountryCode |
string |
iso3166numeric3CountryCode |
string |
name |
string |
partitionId |
integer(int64) |
CustomUse¶
| Name | Type |
|---|---|
id |
integer(int64) |
percentage |
number(double) |
tauiProduct |
TAUIProduct |
useDescription |
string |
useName |
string |
Displayable¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
iconClass |
string |
iconColour |
string |
id |
|
idInPartition |
integer(int64) |
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
recordName |
string |
url |
string |
Document¶
| Name | Type |
|---|---|
comments |
Array<DocumentComment> |
constituentTonnages |
Array<ConstituentTonnage> |
currentDocument |
Document |
currentDocumentId |
integer(int64) |
deleted |
boolean |
deletedDate |
string(date-time) |
description |
string |
docType |
string |
documentCategoryGroups |
Array<DocumentCategoryGroup> |
documentConstituents |
Array<DocumentConstituent> |
documentContactGroups |
Array<DocumentContactGroup> |
documentCreationDate |
string(date) |
documentEntities |
Array<DocumentEntity> |
documentEntityGroups |
Array<DocumentEntityGroup> |
documentLinkAttachments |
Array<DocumentLinkAttachment> |
documentProductGroups |
Array<DocumentProductGroup> |
documentProducts |
Array<DocumentProduct> |
documentTagSet |
Array<DocumentTag> |
downloadTaskLinks |
Array<CampaignContactTaskDocument> |
expirationNotified |
boolean |
expiryDate |
string(date) |
expiryNotifications |
Array<NotificationDocExpiry> |
fileId |
string(uuid) |
fileName |
string |
fileSize |
integer(int32) |
fileType |
string |
folders |
Array<Folder> |
id |
integer(int64) |
index |
integer(int32) |
internalSourceEmails |
Array<DocumentEmailInternal> |
issues |
Array<IssueAndStatement> |
lastUpdated |
string(date-time) |
link |
boolean |
linkedDocuments |
Array<Document> |
newsItem |
boolean |
notifyEmail |
string |
originalFileName |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
permanent |
boolean |
productTonnages |
Array<ProductTonnage> |
relatedDocumentCategoryGroups |
Array<DocumentCategoryGroup> |
relatedDocumentConstituents |
Array<DocumentConstituent> |
relatedDocumentContactGroups |
Array<DocumentContactGroup> |
relatedDocumentEntities |
Array<DocumentEntity> |
relatedDocumentProductGroups |
Array<DocumentProductGroup> |
relatedDocumentProducts |
Array<DocumentProduct> |
retentionDate |
string(date) |
retentionNotifications |
Array<NotificationDocRetention> |
retentionNotified |
boolean |
searchedVia |
Document |
sourceEmail |
Array<DocumentEmailExternal> |
submissions |
Array<ReachITRegistration> |
taskLinks |
Array<CampaignContactTask> |
taskTwoLinks |
Array<CampaignContactTask> |
title |
string |
uploadDate |
string(date-time) |
version |
integer(int32) |
versionIdentifier |
string |
watchingUsers |
Array<User> |
DocumentBudget¶
| Name | Type |
|---|---|
budget |
Budget |
cost |
number |
document |
Document |
id |
integer(int64) |
DocumentCategoryGroup¶
| Name | Type |
|---|---|
categoryGroup |
CategoryGroup |
deleted |
boolean |
document |
Document |
id |
integer(int64) |
DocumentComment¶
| Name | Type |
|---|---|
allDay |
boolean |
breadcrumbParent |
Displayable |
calendarEnd |
string(date-time) |
calendarExtendedProps |
|
calendarSource |
string |
contact |
Contact |
createdDate |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
forTocEntry |
boolean |
greatestAncestor |
Comment |
hidden |
boolean |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
User |
lastUpdatedById |
integer(int64) |
name |
string |
node |
IUCLID6TocNode |
notifications |
Array<NotificationComment> |
partition |
ClientPartition |
published |
boolean |
recordName |
string |
replies |
Array<Comment> |
reply |
boolean |
replyTo |
Comment |
replyToIsUnpublished |
boolean |
serverCreatedReadableDate |
string |
text |
string |
user |
User |
wrapperId |
string |
DocumentConstituent¶
| Name | Type |
|---|---|
constituent |
Constituent |
deleted |
boolean |
document |
Document |
id |
integer(int64) |
DocumentContactGroup¶
| Name | Type |
|---|---|
contactGroup |
ContactGroup |
deleted |
boolean |
document |
Document |
id |
integer(int64) |
DocumentData¶
| Name | Type |
|---|---|
documentCreationDate |
string(date) |
id |
integer(int64) |
name |
string |
partitionId |
integer(int64) |
type |
string |
DocumentDate¶
| Name | Type |
|---|---|
dateAccessed |
string(date-time) |
document |
Document |
events |
Array<CampaignContactEvent> |
id |
integer(int64) |
DocumentEmailExternal¶
| Name | Type |
|---|---|
attachmentsToSave |
Array<string(uuid)> |
ccAddresses |
string |
comments |
Array<DocumentComment> |
constituentTonnages |
Array<ConstituentTonnage> |
currentDocument |
Document |
currentDocumentId |
integer(int64) |
deleted |
boolean |
deletedDate |
string(date-time) |
description |
string |
docType |
string |
documentContactGroups |
Array<DocumentContactGroup> |
documentCreationDate |
string(date) |
documentEntityGroups |
Array<DocumentEntityGroup> |
documentLinkAttachments |
Array<DocumentLinkAttachment> |
documentTagSet |
Array<DocumentTag> |
downloadTaskLinks |
Array<CampaignContactTaskDocument> |
emailBody |
string |
emailDate |
string(date) |
expirationNotified |
boolean |
expiryDate |
string(date) |
expiryNotifications |
Array<NotificationDocExpiry> |
fileId |
string(uuid) |
fileName |
string |
fileSize |
integer(int32) |
fileType |
string |
folders |
Array<Folder> |
id |
integer(int64) |
index |
integer(int32) |
internalSourceEmails |
Array<DocumentEmailInternal> |
issues |
Array<IssueAndStatement> |
lastUpdated |
string(date-time) |
link |
boolean |
linkedDocuments |
Array<Document> |
missingAttachments |
Array<ReceivedEmailAttachment> |
newsItem |
boolean |
notifyEmail |
string |
originalFileName |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
permanent |
boolean |
productTonnages |
Array<ProductTonnage> |
receivedDate |
string(date-time) |
recipient |
string |
relatedDocumentConstituents |
Array<DocumentConstituent> |
relatedDocumentContactGroups |
Array<DocumentContactGroup> |
relatedDocumentEntities |
Array<DocumentEntity> |
relatedDocumentProductGroups |
Array<DocumentProductGroup> |
relatedDocumentProducts |
Array<DocumentProduct> |
retentionDate |
string(date) |
retentionNotifications |
Array<NotificationDocRetention> |
retentionNotified |
boolean |
searchedVia |
Document |
sender |
string |
subject |
string |
taskLinks |
Array<CampaignContactTask> |
taskTwoLinks |
Array<CampaignContactTask> |
title |
string |
uploadDate |
string(date-time) |
version |
integer(int32) |
versionIdentifier |
string |
watchingUsers |
Array<User> |
DocumentEmailInternal¶
| Name | Type |
|---|---|
bcc |
string |
cc |
string |
comments |
Array<DocumentComment> |
constituentTonnages |
Array<ConstituentTonnage> |
currentDocument |
Document |
currentDocumentId |
integer(int64) |
deleted |
boolean |
deletedDate |
string(date-time) |
description |
string |
docType |
string |
documentContactGroups |
Array<DocumentContactGroup> |
documentCreationDate |
string(date) |
documentEntityGroups |
Array<DocumentEntityGroup> |
documentLinkAttachments |
Array<DocumentLinkAttachment> |
documentTagSet |
Array<DocumentTag> |
downloadTaskLinks |
Array<CampaignContactTaskDocument> |
emailBody |
string |
emailDate |
string(date-time) |
expirationNotified |
boolean |
expiryDate |
string(date) |
expiryNotifications |
Array<NotificationDocExpiry> |
fileId |
string(uuid) |
fileName |
string |
fileSize |
integer(int32) |
fileType |
string |
folders |
Array<Folder> |
fromTemplate |
boolean |
id |
integer(int64) |
index |
integer(int32) |
issues |
Array<IssueAndStatement> |
lastUpdated |
string(date-time) |
link |
boolean |
linkedDocuments |
Array<Document> |
newsItem |
boolean |
notifyEmail |
string |
originalFileName |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
permanent |
boolean |
privatise |
boolean |
productTonnages |
Array<ProductTonnage> |
recipients |
Array<ContactRecipient> |
relatedDocumentConstituents |
Array<DocumentConstituent> |
relatedDocumentContactGroups |
Array<DocumentContactGroup> |
relatedDocumentEntities |
Array<DocumentEntity> |
relatedDocumentProductGroups |
Array<DocumentProductGroup> |
relatedDocumentProducts |
Array<DocumentProduct> |
retentionDate |
string(date) |
retentionNotifications |
Array<NotificationDocRetention> |
retentionNotified |
boolean |
saveAsDraft |
boolean |
searchedVia |
Document |
sender |
string |
subject |
string |
taskLinks |
Array<CampaignContactTask> |
taskTwoLinks |
Array<CampaignContactTask> |
title |
string |
uploadDate |
string(date-time) |
version |
integer(int32) |
versionIdentifier |
string |
watchingUsers |
Array<User> |
DocumentEntity¶
| Name | Type |
|---|---|
deleted |
boolean |
document |
Document |
entity |
BaseEntity |
id |
integer(int64) |
DocumentEntityGroup¶
| Name | Type |
|---|---|
document |
Document |
entityGroup |
EntityGroup |
id |
integer(int64) |
DocumentInvoice¶
| Name | Type |
|---|---|
accountantReference |
string |
approved |
boolean |
approvedBy |
User |
approvedDate |
string(date) |
comments |
Array<DocumentComment> |
constituentTonnages |
Array<ConstituentTonnage> |
convertedSubTotal |
number |
currentDocument |
Document |
currentDocumentId |
integer(int64) |
dateReceived |
string(date) |
deleted |
boolean |
deletedDate |
string(date-time) |
description |
string |
docType |
string |
documentBudgets |
Array<DocumentBudget> |
documentCategoryGroups |
Array<DocumentCategoryGroup> |
documentConstituents |
Array<DocumentConstituent> |
documentContactGroups |
Array<DocumentContactGroup> |
documentCreationDate |
string(date) |
documentEntities |
Array<DocumentEntity> |
documentEntityGroups |
Array<DocumentEntityGroup> |
documentInvoiceType |
string |
documentLinkAttachments |
Array<DocumentLinkAttachment> |
documentProductGroups |
Array<DocumentProductGroup> |
documentProducts |
Array<DocumentProduct> |
documentStudies |
Array<DocumentStudy> |
documentTagSet |
Array<DocumentTag> |
downloadTaskLinks |
Array<CampaignContactTaskDocument> |
expirationNotified |
boolean |
expiryDate |
string(date) |
expiryNotifications |
Array<NotificationDocExpiry> |
fileId |
string(uuid) |
fileName |
string |
fileSize |
integer(int32) |
fileType |
string |
folders |
Array<Folder> |
fromEntity |
BaseEntity |
id |
integer(int64) |
index |
integer(int32) |
internalSourceEmails |
Array<DocumentEmailInternal> |
invoiceAmount |
number |
invoiceCurrencyCode |
string |
invoiceDate |
string(date) |
invoiceNumber |
string |
invoiceOverdueDays |
integer(int64) |
issues |
Array<IssueAndStatement> |
lastUpdated |
string(date-time) |
legislation |
string |
lines |
Array<DocumentInvoiceLine> |
link |
boolean |
linkedDocuments |
Array<Document> |
newsItem |
boolean |
notifyEmail |
string |
originalFileName |
string |
overdueNotifications |
Array<NotificationDocOverdue> |
overdueNotified |
boolean |
paidNotifications |
Array<NotificationPaid> |
partition |
ClientPartition |
partitionId |
integer(int64) |
paymentReceived |
boolean |
permanent |
boolean |
productTonnages |
Array<ProductTonnage> |
purchaseOrder |
string |
relatedDocumentCategoryGroups |
Array<DocumentCategoryGroup> |
relatedDocumentConstituents |
Array<DocumentConstituent> |
relatedDocumentContactGroups |
Array<DocumentContactGroup> |
relatedDocumentEntities |
Array<DocumentEntity> |
relatedDocumentProductGroups |
Array<DocumentProductGroup> |
relatedDocumentProducts |
Array<DocumentProduct> |
remarks |
string |
retentionDate |
string(date) |
retentionNotifications |
Array<NotificationDocRetention> |
retentionNotified |
boolean |
searchedVia |
Document |
sent |
boolean |
sentBy |
User |
sentDate |
string(date) |
sourceEmail |
Array<DocumentEmailExternal> |
submissions |
Array<ReachITRegistration> |
subTotal |
number |
taskLinks |
Array<CampaignContactTask> |
taskTwoLinks |
Array<CampaignContactTask> |
title |
string |
toEntity |
BaseEntity |
uploadDate |
string(date-time) |
vat |
number |
version |
integer(int32) |
versionIdentifier |
string |
versions |
Array<Document> |
watchingUsers |
Array<User> |
DocumentInvoiceLine¶
| Name | Type |
|---|---|
amount |
number |
description |
string |
salesCode |
string |
taxed |
boolean |
DocumentIUCLIDOutput¶
| Name | Type |
|---|---|
comments |
Array<DocumentComment> |
constituentTonnages |
Array<ConstituentTonnage> |
context |
IUCLID6WorkingContext |
creationDate |
string(date) |
currentDocument |
Document |
currentDocumentId |
integer(int64) |
deleted |
boolean |
deletedDate |
string(date-time) |
description |
string |
docType |
string |
documentContactGroups |
Array<DocumentContactGroup> |
documentCreationDate |
string(date) |
documentEntityGroups |
Array<DocumentEntityGroup> |
documentTagSet |
Array<DocumentTag> |
downloadTaskLinks |
Array<CampaignContactTaskDocument> |
expirationNotified |
boolean |
expiryDate |
string(date) |
expiryNotifications |
Array<NotificationDocExpiry> |
fileId |
string(uuid) |
fileName |
string |
fileSize |
integer(int32) |
fileType |
string |
folders |
Array<Folder> |
id |
integer(int64) |
index |
integer(int32) |
integration |
Integration |
IUCLIDAuthor |
string |
iuclidauthor |
string |
lastUpdated |
string(date-time) |
legalEntity |
string |
link |
boolean |
linkedDocuments |
Array<Document> |
manifest |
IUCLID6Manifest |
newsItem |
boolean |
notifyEmail |
string |
originalFileName |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
permanent |
boolean |
productTonnages |
Array<ProductTonnage> |
relatedDocumentConstituents |
Array<DocumentConstituent> |
relatedDocumentContactGroups |
Array<DocumentContactGroup> |
relatedDocumentEntities |
Array<DocumentEntity> |
relatedDocumentProductGroups |
Array<DocumentProductGroup> |
relatedDocumentProducts |
Array<DocumentProduct> |
retentionDate |
string(date) |
retentionNotifications |
Array<NotificationDocRetention> |
retentionNotified |
boolean |
searchedVia |
Document |
taskLinks |
Array<CampaignContactTask> |
taskTwoLinks |
Array<CampaignContactTask> |
title |
string |
uploadDate |
string(date-time) |
uuid |
string |
version |
integer(int32) |
versionIdentifier |
string |
watchingUsers |
Array<User> |
DocumentLink¶
| Name | Type |
|---|---|
allDownloaded |
boolean |
autoExpire |
boolean |
clientPartition |
ClientPartition |
code |
string |
contact |
Contact |
created |
string(date-time) |
dateAllDownLoaded |
string(date-time) |
documentLinkAttachments |
Array<DocumentLinkAttachment> |
emails |
Array<DocumentEmailInternal> |
expiryDays |
integer(int32) |
id |
integer(int64) |
link |
string |
reminderDate |
string(date) |
reminderDatePassed |
boolean |
tonnageAndUseEnquiries |
Array<TonnageAndUseEnquiry> |
DocumentLinkAttachment¶
| Name | Type |
|---|---|
document |
Document |
documentLinks |
Array<DocumentLink> |
id |
integer(int64) |
DocumentProduct¶
| Name | Type |
|---|---|
deleted |
boolean |
document |
Document |
id |
integer(int64) |
product |
Product |
DocumentProductGroup¶
| Name | Type |
|---|---|
document |
Document |
id |
integer(int64) |
productGroup |
ProductGroup |
DocumentStudy¶
| Name | Type |
|---|---|
cost |
number |
document |
Document |
id |
integer(int64) |
study |
Study |
DocumentTag¶
| Name | Type |
|---|---|
deleted |
boolean |
document |
Document |
id |
integer(int64) |
tag |
Tag |
EntityBudget¶
| Name | Type |
|---|---|
budget |
Budget |
constituent |
Constituent |
constituentEntity |
ConstituentEntity |
entity |
BaseEntity |
id |
integer(int64) |
purchaseOrderNumber |
string |
EntityComment¶
| Name | Type |
|---|---|
allDay |
boolean |
breadcrumbParent |
Displayable |
calendarEnd |
string(date-time) |
calendarExtendedProps |
|
calendarSource |
string |
contact |
Contact |
createdDate |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
greatestAncestor |
Comment |
hidden |
boolean |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
User |
lastUpdatedById |
integer(int64) |
name |
string |
notifications |
Array<NotificationComment> |
partition |
ClientPartition |
published |
boolean |
recordName |
string |
replies |
Array<Comment> |
reply |
boolean |
replyTo |
Comment |
replyToIsUnpublished |
boolean |
serverCreatedReadableDate |
string |
text |
string |
user |
User |
EntityCostRole¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
journal |
string |
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
recordName |
string |
url |
string |
EntityData¶
| Name | Type |
|---|---|
companyNo |
string |
dunnNo |
string |
id |
integer(int64) |
name |
string |
partitionId |
integer(int64) |
utr |
string |
vatNo |
string |
EntityEntityGroup¶
| Name | Type |
|---|---|
entity |
BaseEntity |
entityGroup |
EntityGroup |
id |
integer(int64) |
EntityGroup¶
| Name | Type |
|---|---|
name |
string |
partitionId |
integer(int64) |
EntityRole¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
iconClass |
string |
iconColour |
string |
id |
string |
idInPartition |
integer(int64) |
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
recordName |
string |
url |
string |
EntityStudy¶
| Name | Type |
|---|---|
constituent |
Constituent |
constituentEntity |
ConstituentEntity |
entity |
BaseEntity |
entityCostRole |
EntityCostRole |
id |
integer(int64) |
purchaseOrderNumber |
string |
purpose |
string |
sharedWithOthers |
boolean |
study |
Study |
EntityStudyGroup¶
| Name | Type |
|---|---|
constituent |
Constituent |
constituentEntity |
ConstituentEntity |
entity |
BaseEntity |
entityCostRole |
EntityCostRole |
group |
StudyGroup |
id |
integer(int64) |
purchaseOrderNumber |
string |
purpose |
string |
Folder¶
| Name | Type |
|---|---|
children |
Array<Folder> |
created |
string(date-time) |
createdBy |
User |
deletable |
boolean |
documents |
Array<Document> |
folderLinks |
string |
folderPath |
string |
id |
integer(int64) |
name |
string |
parent |
Folder |
partitionId |
integer(int64) |
study |
Study |
FolderData¶
| Name | Type |
|---|---|
id |
integer(int64) |
name |
string |
parent |
FolderData |
partitionId |
integer(int64) |
FormulationData¶
| Name | Type |
|---|---|
constituent |
integer(int64) |
id |
integer(int64) |
parentConstituent |
integer(int64) |
parentProduct |
integer(int64) |
percentage |
number |
I6CategoryDocumentDefinitionIdentifier¶
| Name | Type |
|---|---|
documentSubType |
string |
documentType |
string |
Integration¶
| Name | Type |
|---|---|
authType |
string |
created |
string(date-time) |
credential |
string |
credentialEncrypted |
string |
display |
string |
entity |
BaseEntity |
host |
string |
id |
integer(int64) |
iuclidDocuments |
Array<DocumentIUCLIDOutput> |
lastUpdated |
string(date-time) |
name |
string |
principal |
string |
refreshToken |
string |
refreshTokenEncrypted |
string |
refreshTokenExpired |
boolean |
token |
string |
tokenEncrypted |
string |
tokenExpired |
boolean |
tokenExpires |
string(date-time) |
tokenTransient |
string |
type |
string |
InvoicePageInfo¶
| Name | Type |
|---|---|
address |
string |
invoicePageFooter |
string |
invoicingContacts |
string |
otherEntity |
BaseEntity |
purchaseNumber |
string |
showing |
string |
vat |
string |
IssueAndStatement¶
| Name | Type |
|---|---|
basis |
string |
breadcrumbParent |
Displayable |
clientPartition |
ClientPartition |
commentDisplayUrl |
string |
comments |
Array<IssueAndStatementComment> |
commentsEditPermission |
string |
commentsPermission |
string |
commentType |
string |
constituentIds |
Array<integer(int64)> |
constituents |
Array<Constituent> |
created |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
emailCode |
string |
emailPrefix |
string |
entities |
Array<BaseEntity> |
entityIds |
Array<integer(int64)> |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
inventoryId |
string(uuid) |
issue |
string |
lastUpdated |
string(date-time) |
lastUpdatedById |
integer(int64) |
name |
string |
notes |
string |
oneToOne |
boolean |
partition |
ClientPartition |
partitionId |
integer(int64) |
productIds |
Array<integer(int64)> |
products |
Array<Product> |
recordName |
string |
relevantEntities |
Array<BaseEntity> |
reviewDate |
string(date) |
reviewNotified |
boolean |
statement |
string |
studies |
Array<Study> |
studyIds |
Array<integer(int64)> |
supportingDocuments |
Array<Document> |
tasks |
Array<CampaignContactTask> |
url |
string |
version |
integer(int64) |
watching |
boolean |
watchingUsers |
Array<User> |
IssueAndStatementComment¶
| Name | Type |
|---|---|
allDay |
boolean |
breadcrumbParent |
Displayable |
calendarEnd |
string(date-time) |
calendarExtendedProps |
|
calendarSource |
string |
contact |
Contact |
createdDate |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
greatestAncestor |
Comment |
hidden |
boolean |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
User |
lastUpdatedById |
integer(int64) |
name |
string |
notifications |
Array<NotificationComment> |
partition |
ClientPartition |
published |
boolean |
recordName |
string |
replies |
Array<Comment> |
reply |
boolean |
replyTo |
Comment |
replyToIsUnpublished |
boolean |
serverCreatedReadableDate |
string |
text |
string |
user |
User |
IUCLID6Manifest¶
| Name | Type |
|---|---|
application |
string |
archiveType |
string |
author |
string |
baseDocument |
IUCLIDDocumentWrapper |
baseDocumentUuid |
string |
comment |
string |
context |
IUCLID6WorkingContext |
created |
string(date-time) |
legislation |
|
relevantDocumentType |
string |
submissionTypeString |
string |
title |
string |
treeName |
string |
IUCLID6TocNode¶
| Name | Type |
|---|---|
changeType |
string |
children |
Array<IUCLID6TocNode> |
code |
string |
commentCount |
integer(int64) |
descendantComments |
boolean |
display |
string |
forType |
string |
id |
integer(int64) |
idString |
string |
matrix |
boolean |
records |
Array<IUCLIDDocumentWrapper> |
title |
string |
IUCLID6WorkingContext¶
| Name | Type |
|---|---|
applicableFor |
string |
id |
integer(int64) |
identifier |
string |
key |
string |
provider |
string |
title |
string |
tree |
string |
IUCLIDDocumentWrapper¶
| Name | Type |
|---|---|
attachments |
Array<IUCLIDDocumentWrapper> |
categories |
Array<IUCLIDDocumentWrapper> |
category |
boolean |
changeType |
string |
commentCount |
integer(int64) |
containerId |
string |
content |
string(byte) |
creationDate |
string(date-time) |
creationDateFromString |
string |
creationTool |
string |
definition |
string |
definitionVersion |
string |
descendantComments |
boolean |
display |
string |
documentType |
string |
dossier |
IUCLIDDocumentWrapper |
dossierSubject |
IUCLIDDocumentWrapper |
dossierSubjectKey |
string |
endpointSummary |
boolean |
href |
string |
i5Origin |
boolean |
i6CategoryDocumentDefinitionIdentifiers |
Array<I6CategoryDocumentDefinitionIdentifier> |
idString |
string |
iuclidVersion |
string |
key |
string |
lastModificationDate |
string(date-time) |
lastModificationDateFromString |
string |
literatureDocuments |
Array<IUCLIDDocumentWrapper> |
name |
string |
orderInSectionNo |
string |
otherReferences |
Array<IUCLIDDocumentWrapper> |
ownerLegalEntity |
IUCLIDDocumentWrapper |
records |
|
refSubstance |
IUCLIDDocumentWrapper |
snapshotCreationTool |
string |
subject |
IUCLIDDocumentWrapper |
submissionType |
string |
submissionTypeVersion |
string |
submittingLegalEntity |
string |
substance |
boolean |
substances |
Array<IUCLIDDocumentWrapper> |
subType |
string |
template |
boolean |
templates |
Array<IUCLIDDocumentWrapper> |
tree |
Array<IUCLID6TocNode> |
type |
string |
uuid |
string |
MailjetTemplatedEmail¶
| Name | Type |
|---|---|
attachments |
Array<MailjetTemplatedEmailAttachment> |
globalTemplateVars |
|
priority |
string |
recipients |
Array<MailjetTemplatedEmailRecipient> |
subject |
string |
templateName |
string |
MailjetTemplatedEmailAttachment¶
| Name | Type |
|---|---|
data |
string(byte) |
filename |
string |
type |
string |
MailjetTemplatedEmailRecipient¶
| Name | Type |
|---|---|
email |
string |
templateVars |
NotificationActivityOverdue¶
| Name | Type |
|---|---|
activity |
StudyActivity |
breadcrumbParent |
Displayable |
created |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCode |
string |
displayCodePartial |
string |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
mailjetTemplateEmail |
MailjetTemplatedEmail |
mailjetTemplateName |
string |
mailjetTemplateVars |
|
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
planned |
string(date) |
read |
boolean |
recordName |
string |
serverCreatedDate |
string(date-time) |
url |
string |
user |
User |
NotificationCampaignSecurityIssue¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
campaign |
Campaign |
created |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCode |
string |
displayCodePartial |
string |
displayIssueType |
string |
hasPageSecurityIssues |
boolean |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
mailjetTemplateEmail |
MailjetTemplatedEmail |
mailjetTemplateName |
string |
mailjetTemplateVars |
|
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
read |
boolean |
recordName |
string |
serverCreatedDate |
string(date-time) |
url |
string |
user |
User |
NotificationCampaignSurvey¶
| Name | Type |
|---|---|
baseUrl |
string |
breadcrumbParent |
Displayable |
campaignContactTask |
CampaignContactTask |
contact |
Contact |
created |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCode |
string |
displayCodePartial |
string |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
mailjetTemplateEmail |
MailjetTemplatedEmail |
mailjetTemplateName |
string |
mailjetTemplateVars |
|
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
read |
boolean |
recordName |
string |
serverCreatedDate |
string(date-time) |
taskUrl |
string |
url |
string |
user |
User |
NotificationCampaignUpload¶
| Name | Type |
|---|---|
baseUrl |
string |
breadcrumbParent |
Displayable |
campaignContactTask |
CampaignContactTask |
contact |
Contact |
created |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCode |
string |
displayCodePartial |
string |
fileName |
string |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
mailjetTemplateEmail |
MailjetTemplatedEmail |
mailjetTemplateName |
string |
mailjetTemplateVars |
|
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
read |
boolean |
recordName |
string |
serverCreatedDate |
string(date-time) |
url |
string |
user |
User |
NotificationComment¶
| Name | Type |
|---|---|
baseUrl |
string |
breadcrumbParent |
Displayable |
comment |
Comment |
created |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCode |
string |
displayCodePartial |
string |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
mailjetTemplateEmail |
MailjetTemplatedEmail |
mailjetTemplateName |
string |
mailjetTemplateVars |
|
name |
string |
parent |
Commentable |
partition |
ClientPartition |
partitionId |
integer(int64) |
read |
boolean |
recordName |
string |
serverCreatedDate |
string(date-time) |
type |
string |
url |
string |
user |
User |
NotificationDocExpiry¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
created |
string(date-time) |
daysUntilExpiry |
integer(int64) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCode |
string |
displayCodePartial |
string |
document |
Document |
drc |
boolean |
expiryDate |
string(date) |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
mailjetTemplateEmail |
MailjetTemplatedEmail |
mailjetTemplateName |
string |
mailjetTemplateVars |
|
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
read |
boolean |
recordName |
string |
serverCreatedDate |
string(date-time) |
url |
string |
user |
User |
NotificationDocOverdue¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
created |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCode |
string |
displayCodePartial |
string |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
invoice |
DocumentInvoice |
invoiceDate |
string(date) |
invoiceOverdueDays |
integer(int64) |
mailjetTemplateEmail |
MailjetTemplatedEmail |
mailjetTemplateName |
string |
mailjetTemplateVars |
|
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
read |
boolean |
recordName |
string |
serverCreatedDate |
string(date-time) |
url |
string |
user |
User |
NotificationDocRetention¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
created |
string(date-time) |
daysUntilExpiry |
integer(int64) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCode |
string |
displayCodePartial |
string |
document |
Document |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
mailjetTemplateEmail |
MailjetTemplatedEmail |
mailjetTemplateName |
string |
mailjetTemplateVars |
|
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
read |
boolean |
recordName |
string |
retentionDate |
string(date) |
serverCreatedDate |
string(date-time) |
url |
string |
user |
User |
NotificationIuclidReview¶
| Name | Type |
|---|---|
approval |
boolean |
baseUrl |
string |
breadcrumbParent |
Displayable |
campaignContactTask |
CampaignContactTask |
contact |
Contact |
created |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCode |
string |
displayCodePartial |
string |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
mailjetTemplateEmail |
MailjetTemplatedEmail |
mailjetTemplateName |
string |
mailjetTemplateVars |
|
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
read |
boolean |
recordName |
string |
serverCreatedDate |
string(date-time) |
url |
string |
user |
User |
NotificationPageChange¶
| Name | Type |
|---|---|
baseUrl |
string |
breadcrumbParent |
Displayable |
created |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCode |
string |
displayCodePartial |
string |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
mailjetTemplateEmail |
MailjetTemplatedEmail |
mailjetTemplateName |
string |
mailjetTemplateVars |
|
name |
string |
page |
CampaignPage |
partition |
ClientPartition |
partitionId |
integer(int64) |
read |
boolean |
recordName |
string |
serverCreatedDate |
string(date-time) |
type |
string |
url |
string |
user |
User |
NotificationPaid¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
created |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCode |
string |
displayCodePartial |
string |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
invoice |
DocumentInvoice |
mailjetTemplateEmail |
MailjetTemplatedEmail |
mailjetTemplateName |
string |
mailjetTemplateVars |
|
name |
string |
paidDate |
string(date) |
partition |
ClientPartition |
partitionId |
integer(int64) |
read |
boolean |
recordName |
string |
serverCreatedDate |
string(date-time) |
url |
string |
user |
User |
PageableObject¶
| Name | Type |
|---|---|
offset |
integer(int64) |
paged |
boolean |
pageNumber |
integer(int32) |
pageSize |
integer(int32) |
sort |
SortObject |
unpaged |
boolean |
PageBudgetData¶
| Name | Type |
|---|---|
content |
Array<BudgetData> |
empty |
boolean |
first |
boolean |
last |
boolean |
number |
integer(int32) |
numberOfElements |
integer(int32) |
pageable |
PageableObject |
size |
integer(int32) |
sort |
SortObject |
totalElements |
integer(int64) |
totalPages |
integer(int32) |
PageConstituentData¶
| Name | Type |
|---|---|
content |
Array<ConstituentData> |
empty |
boolean |
first |
boolean |
last |
boolean |
number |
integer(int32) |
numberOfElements |
integer(int32) |
pageable |
PageableObject |
size |
integer(int32) |
sort |
SortObject |
totalElements |
integer(int64) |
totalPages |
integer(int32) |
PageContactData¶
| Name | Type |
|---|---|
content |
Array<ContactData> |
empty |
boolean |
first |
boolean |
last |
boolean |
number |
integer(int32) |
numberOfElements |
integer(int32) |
pageable |
PageableObject |
size |
integer(int32) |
sort |
SortObject |
totalElements |
integer(int64) |
totalPages |
integer(int32) |
PageDocumentData¶
| Name | Type |
|---|---|
content |
Array<DocumentData> |
empty |
boolean |
first |
boolean |
last |
boolean |
number |
integer(int32) |
numberOfElements |
integer(int32) |
pageable |
PageableObject |
size |
integer(int32) |
sort |
SortObject |
totalElements |
integer(int64) |
totalPages |
integer(int32) |
PageEntityData¶
| Name | Type |
|---|---|
content |
Array<EntityData> |
empty |
boolean |
first |
boolean |
last |
boolean |
number |
integer(int32) |
numberOfElements |
integer(int32) |
pageable |
PageableObject |
size |
integer(int32) |
sort |
SortObject |
totalElements |
integer(int64) |
totalPages |
integer(int32) |
PageFolderData¶
| Name | Type |
|---|---|
content |
Array<FolderData> |
empty |
boolean |
first |
boolean |
last |
boolean |
number |
integer(int32) |
numberOfElements |
integer(int32) |
pageable |
PageableObject |
size |
integer(int32) |
sort |
SortObject |
totalElements |
integer(int64) |
totalPages |
integer(int32) |
PageProductData¶
| Name | Type |
|---|---|
content |
Array<ProductData> |
empty |
boolean |
first |
boolean |
last |
boolean |
number |
integer(int32) |
numberOfElements |
integer(int32) |
pageable |
PageableObject |
size |
integer(int32) |
sort |
SortObject |
totalElements |
integer(int64) |
totalPages |
integer(int32) |
PageRegistrationData¶
| Name | Type |
|---|---|
content |
Array<RegistrationData> |
empty |
boolean |
first |
boolean |
last |
boolean |
number |
integer(int32) |
numberOfElements |
integer(int32) |
pageable |
PageableObject |
size |
integer(int32) |
sort |
SortObject |
totalElements |
integer(int64) |
totalPages |
integer(int32) |
PageStudyData¶
| Name | Type |
|---|---|
content |
Array<StudyData> |
empty |
boolean |
first |
boolean |
last |
boolean |
number |
integer(int32) |
numberOfElements |
integer(int32) |
pageable |
PageableObject |
size |
integer(int32) |
sort |
SortObject |
totalElements |
integer(int64) |
totalPages |
integer(int32) |
PageSubmissionData¶
| Name | Type |
|---|---|
content |
Array<SubmissionData> |
empty |
boolean |
first |
boolean |
last |
boolean |
number |
integer(int32) |
numberOfElements |
integer(int32) |
pageable |
PageableObject |
size |
integer(int32) |
sort |
SortObject |
totalElements |
integer(int64) |
totalPages |
integer(int32) |
PairIntegerInteger¶
| Name | Type |
|---|---|
key |
integer(int32) |
left |
integer(int32) |
right |
integer(int32) |
value |
integer(int32) |
PartitionData¶
| Name | Type |
|---|---|
email |
string |
id |
integer(int64) |
name |
string |
Party¶
| Name | Type |
|---|---|
addressLine1 |
string |
addressLine2 |
string |
addressLine3 |
string |
addressType |
string |
contacts |
Array<Contact> |
country |
Country |
countyStateRegion |
string |
deleted |
boolean |
description |
string |
entity |
BaseEntity |
fax |
string |
id |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
User |
lastUpdatedByEmail |
string |
lastUpdatedById |
integer(int64) |
partitionId |
integer(int64) |
plants |
Array<Plant> |
postcode |
string |
remarks |
string |
sapBusinessReference |
string |
telephone |
string |
townCity |
string |
website |
string |
Plant¶
| Name | Type |
|---|---|
constituentPlants |
Array<ConstituentPlant> |
id |
integer(int64) |
name |
string |
party |
Party |
plantCode |
string |
productPlants |
Array<ProductPlant> |
Product¶
| Name | Type |
|---|---|
archived |
boolean |
id |
integer(int64) |
name |
string |
ownerManufacturer |
string |
partitionId |
integer(int64) |
ProductContact¶
| Name | Type |
|---|---|
contact |
Contact |
contactType |
string |
deleted |
boolean |
id |
integer(int64) |
product |
Product |
ProductData¶
| Name | Type |
|---|---|
deleted |
boolean |
id |
integer(int64) |
name |
string |
ownerManufacturer |
string |
partitionId |
integer(int64) |
ProductEntity¶
| Name | Type |
|---|---|
baseEntity |
BaseEntity |
deleted |
boolean |
entityRoles |
Array<EntityRole> |
id |
integer(int64) |
partitionId |
integer(int64) |
product |
Product |
ProductEntityContact¶
| Name | Type |
|---|---|
contact |
Contact |
deleted |
boolean |
id |
integer(int64) |
productEntity |
ProductEntity |
ProductGroup¶
| Name | Type |
|---|---|
groupName |
string |
partitionId |
integer(int64) |
ProductParty¶
| Name | Type |
|---|---|
deleted |
boolean |
id |
integer(int64) |
party |
Party |
product |
Product |
ProductPartyContact¶
| Name | Type |
|---|---|
contact |
Contact |
deleted |
boolean |
id |
integer(int64) |
productParty |
ProductParty |
ProductPlant¶
| Name | Type |
|---|---|
id |
integer(int64) |
plant |
Plant |
product |
Product |
ProductTonnage¶
| Name | Type |
|---|---|
deleted |
boolean |
document |
Document |
enteredDate |
string(date) |
entryYear |
integer(int32) |
forecast |
boolean |
forEntity |
BaseEntity |
id |
integer(int64) |
inAnArticle |
number(double) |
lastUpdated |
string(date) |
mixture |
number(double) |
monomerInAPolymer |
number(double) |
notes |
string |
notInAnArticle |
number(double) |
party |
Party |
product |
Product |
reachLegislation |
string |
substanceOrUnknown |
number(double) |
tonnesImported |
number(double) |
tonnesManufactured |
number(double) |
user |
User |
ReachITRegistration¶
| Name | Type |
|---|---|
constituent |
Constituent |
dateAccepted |
string(date) |
dateIssued |
string(date) |
dateSubmitted |
string(date) |
forEntity |
BaseEntity |
id |
integer(int64) |
iuclidDossierReference |
string |
leadRegistrant |
BaseEntity |
notes |
string |
partitionId |
integer(int64) |
passedPipeline |
boolean |
reachDossierType |
string |
reachRegistration |
ReachRegistration |
reason |
string |
submissionNumber |
string |
supportingDocument |
Document |
tonnageBand |
string |
ReachRegistration¶
| Name | Type |
|---|---|
constituent |
Constituent |
constituentTonnages |
Array<ConstituentTonnage> |
currentTonnageBandToImport |
string |
ecName |
string |
ecNumber |
string |
enquiryNumber |
string |
exemption |
string |
exemptionClaimed |
string |
exemptionComment |
string |
exemptionType |
string |
forEntity |
BaseEntity |
id |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
User |
legalEntity |
BaseEntity |
notPreregistered |
string |
onlyRepresentative |
BaseEntity |
originEntity |
BaseEntity |
partitionId |
integer(int64) |
ppordNumber |
string |
preregistered |
boolean |
preregisteredTonnageBand |
string |
preregistrationDate |
string(date) |
preregistrationName |
string |
preregistrationNumber |
string |
publicName |
string |
reachDossierType |
string |
reachITRegistrations |
Array<ReachITRegistration> |
reachLegislation |
string |
reachRole |
string |
reachSubstanceTypeComposition |
string |
reachSubstanceTypeOrigin |
string |
registeredTonnageBands |
Array<RegisteredTonnageBandWithDate> |
registrationDate |
string(date) |
registrationName |
string |
registrationNotes |
string |
registrationNumber |
string |
submissionDate |
string(date) |
submissionNumber |
string |
submissionType |
string |
substanceTypeCompositionOther |
string |
substanceTypeOriginOther |
string |
uclidID |
string |
ReceivedEmail¶
| Name | Type |
|---|---|
ccAddresses |
string |
clientPartition |
ClientPartition |
content |
string |
contentType |
string |
dateAttachmentsSaved |
string(date-time) |
dateMessageSaved |
string(date-time) |
dateReceived |
string(date-time) |
deleted |
boolean |
emailAttachments |
Array<ReceivedEmailAttachment> |
fromAddress |
string |
id |
integer(int64) |
messageRead |
boolean |
recipients |
string |
subject |
string |
ReceivedEmailAttachment¶
| Name | Type |
|---|---|
fileId |
string(uuid) |
filename |
string |
id |
integer(int64) |
receivedEmail |
ReceivedEmail |
RegisteredTonnageBandWithDate¶
| Name | Type |
|---|---|
allDay |
boolean |
breadcrumbParent |
Displayable |
calendarDisplay |
string |
calendarEnd |
string(date-time) |
calendarExtendedProps |
|
calendarSource |
string |
calendarStart |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
reachRegistration |
ReachRegistration |
recordName |
string |
registeredTonnageBand |
string |
start |
string(date) |
url |
string |
RegistrationData¶
| Name | Type |
|---|---|
constituent |
ConstituentData |
id |
integer(int64) |
reachLegislation |
string |
registrationDate |
string(date) |
registrationName |
string |
registrationNumber |
string |
Role¶
| Name | Type |
|---|---|
admin |
boolean |
deletable |
boolean |
externalGroups |
Array<string> |
forCampaign |
boolean |
forInternal |
boolean |
id |
integer(int64) |
name |
string |
penmanAdmin |
boolean |
permissions |
Array<string> |
SecurityIssue¶
| Name | Type |
|---|---|
error |
string |
html |
string |
uuid |
string(uuid) |
SortObject¶
| Name | Type |
|---|---|
empty |
boolean |
sorted |
boolean |
unsorted |
boolean |
Species¶
| Name | Type |
|---|---|
description |
string |
id |
integer(int64) |
Study¶
| Name | Type |
|---|---|
code |
string |
end |
string(date) |
folder |
Folder |
id |
integer(int64) |
partitionId |
integer(int64) |
purpose |
string |
species |
Array<Species> |
start |
string(date) |
status |
string |
StudyActivity¶
| Name | Type |
|---|---|
allDay |
boolean |
autoPlannedAfter |
integer(int64) |
autoPlannedAfterPrevious |
integer(int64) |
autoPlannedAfterPreviousFallback |
integer(int64) |
breadcrumbParent |
Displayable |
calendarEnd |
string(date-time) |
calendarExtendedProps |
|
calendarSource |
string |
calendarStart |
string(date-time) |
commentCount |
integer(int64) |
commentDisplayUrl |
string |
comments |
Array<StudyActivityComment> |
commentsEditPermission |
string |
commentsPermission |
string |
commentType |
string |
completed |
string(date) |
daysOverdue |
integer(int64) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
editable |
boolean |
fromTemplate |
boolean |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
inheritingGroupActivities |
Array<StudyGroupActivity> |
inheritingGroupNames |
Array<string> |
multipleInheritanceDates |
boolean |
name |
string |
overdue |
boolean |
overdueNotifications |
Array<NotificationActivityOverdue> |
overdueNotified |
boolean |
partition |
ClientPartition |
partitionId |
integer(int64) |
planned |
string(date) |
recordName |
string |
signedBy |
User |
studyNumber |
StudyNumber |
template |
StudyActivityTemplate |
url |
string |
watching |
boolean |
StudyActivityComment¶
| Name | Type |
|---|---|
allDay |
boolean |
breadcrumbParent |
Displayable |
calendarEnd |
string(date-time) |
calendarExtendedProps |
|
calendarSource |
string |
contact |
Contact |
createdDate |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
greatestAncestor |
Comment |
hidden |
boolean |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
User |
lastUpdatedById |
integer(int64) |
name |
string |
notifications |
Array<NotificationComment> |
partition |
ClientPartition |
published |
boolean |
recordName |
string |
replies |
Array<Comment> |
reply |
boolean |
replyTo |
Comment |
replyToIsUnpublished |
boolean |
serverCreatedReadableDate |
string |
text |
string |
user |
User |
StudyActivityTemplate¶
| Name | Type |
|---|---|
activities |
Array<StudyActivity> |
autoPlannedAfter |
integer(int64) |
autoPlannedAfterPrevious |
integer(int64) |
id |
integer(int64) |
name |
string |
responsible |
string |
timelineTemplate |
StudyTimelineTemplate |
StudyCostOverviewRow¶
| Name | Type |
|---|---|
balance |
number |
balanceIn |
number |
categoryGroups |
Array<CategoryGroup> |
constituent |
Constituent |
constituentsEntities |
Array<ConstituentEntity> |
constituentsOfInterest |
Array<Constituent> |
cost |
number |
costOut |
number |
costRoleDisplays |
Array<string> |
costRoles |
Array<EntityCostRole> |
currency |
Properties: currencyCode, numericCodeAsString, displayName, symbol, defaultFractionDigits, numericCode |
entity |
BaseEntity |
entityStudies |
Array<EntityStudy> |
month |
string |
monthDisplay |
string |
outgoingInvoices |
Array<DocumentInvoice> |
paid |
number |
paidIn |
number |
purchaseOrderNumbers |
Array<string> |
quarter |
integer(int32) |
reasonsForInterest |
Array<string> |
registrationNumbers |
Array<string> |
studies |
Array<Study> |
study |
Study |
year |
integer(int32) |
StudyData¶
| Name | Type |
|---|---|
end |
string(date) |
id |
integer(int64) |
name |
string |
partitionId |
integer(int64) |
purpose |
string |
start |
string(date) |
status |
string |
StudyGroup¶
| Name | Type |
|---|---|
activities |
Array<StudyGroupActivity> |
breadcrumbParent |
Displayable |
clientPartition |
ClientPartition |
commentDisplayUrl |
string |
comments |
Array<StudyGroupComment> |
commentsEditPermission |
string |
commentsPermission |
string |
commentType |
string |
created |
string(date-time) |
description |
string |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
entityStudyGroups |
Array<EntityStudyGroup> |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedById |
integer(int64) |
name |
string |
overriddenStudies |
Array<Study> |
partition |
ClientPartition |
partitionId |
integer(int64) |
recordName |
string |
studies |
Array<Study> |
studiesCount |
integer(int64) |
url |
string |
watching |
boolean |
watchingUsers |
Array<User> |
StudyGroupActivity¶
| Name | Type |
|---|---|
group |
StudyGroup |
id |
integer(int64) |
name |
string |
planned |
string(date) |
StudyGroupComment¶
| Name | Type |
|---|---|
allDay |
boolean |
breadcrumbParent |
Displayable |
calendarEnd |
string(date-time) |
calendarExtendedProps |
|
calendarSource |
string |
contact |
Contact |
createdDate |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
greatestAncestor |
Comment |
hidden |
boolean |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
User |
lastUpdatedById |
integer(int64) |
name |
string |
notifications |
Array<NotificationComment> |
partition |
ClientPartition |
published |
boolean |
recordName |
string |
replies |
Array<Comment> |
reply |
boolean |
replyTo |
Comment |
replyToIsUnpublished |
boolean |
serverCreatedReadableDate |
string |
text |
string |
user |
User |
StudyNumber¶
| Name | Type |
|---|---|
activities |
Array<StudyActivity> |
activity |
string |
activityStudyNumber |
string |
contractRef |
string |
cost |
number |
emptyCosts |
boolean |
id |
integer(int64) |
payments |
Array<StudyPaymentActual> |
publishedCost |
number |
studyNumber |
string |
testingLaboratory |
TestingLaboratory |
StudyPaymentActual¶
| Name | Type |
|---|---|
budget |
Budget |
cost |
number |
estimatedDate |
string(date) |
id |
integer(int64) |
name |
string |
percentage |
number |
quarter |
integer(int32) |
studyNumber |
StudyNumber |
type |
string |
year |
integer(int32) |
yearMonth |
Properties: year, month, monthValue, leapYear |
yearQuarter |
PairIntegerInteger |
StudyTimelineTemplate¶
| Name | Type |
|---|---|
activityTemplates |
Array<StudyActivityTemplate> |
id |
integer(int64) |
name |
string |
SubmissionData¶
| Name | Type |
|---|---|
dateAccepted |
string(date) |
dateIssued |
string(date) |
dateSubmitted |
string(date) |
id |
integer(int64) |
iuclidDossierReference |
string |
notes |
string |
reachDossierType |
string |
reason |
string |
registration |
RegistrationData |
submissionNumber |
string |
tonnageBand |
string |
SurveyField¶
| Name | Type |
|---|---|
campaignContactTask |
CampaignContactTask |
defaultValue |
string |
fieldType |
string |
id |
integer(int64) |
index |
integer(int32) |
name |
string |
nameAsText |
string |
nameContainsHtml |
boolean |
nameIssues |
Array<SecurityIssue> |
range |
boolean |
rangeMaximum |
number |
rangeMinimum |
number |
required |
boolean |
selectOptionValues |
Array<SurveyFieldSelectValue> |
selectValuesArray |
Array<string> |
surveyValues |
Array<SurveyValue> |
SurveyFieldSelectValue¶
| Name | Type |
|---|---|
id |
integer(int64) |
index |
integer(int32) |
surveyField |
SurveyField |
value |
string |
SurveyFieldTemplate¶
| Name | Type |
|---|---|
defaultValue |
string |
id |
integer(int64) |
index |
integer(int32) |
options |
Array<SurveyFieldTemplateOption> |
question |
string |
range |
boolean |
rangeMaximum |
number |
rangeMinimum |
number |
required |
boolean |
template |
CampaignTaskTemplate |
type |
string |
SurveyFieldTemplateOption¶
| Name | Type |
|---|---|
id |
integer(int64) |
option |
string |
template |
SurveyFieldTemplate |
SurveyFieldValue¶
| Name | Type |
|---|---|
deleted |
boolean |
fieldType |
string |
file |
string(binary) |
fileName |
string |
id |
integer(int64) |
surveyField |
SurveyField |
value |
string |
valueAsDate |
string(date) |
valueAsUUID |
string(uuid) |
valueSanitized |
string |
SurveyValue¶
| Name | Type |
|---|---|
campaignContactEvent |
CampaignContactEvent |
deleted |
boolean |
fieldType |
string |
file |
string(binary) |
fileName |
string |
id |
integer(int64) |
surveyField |
SurveyField |
value |
string |
valueAsDate |
string(date) |
valueAsUUID |
string(uuid) |
valueSanitized |
string |
Tag¶
| Name | Type |
|---|---|
id |
TagPartitionPk |
tagText |
string |
TagPartitionPk¶
| Name | Type |
|---|---|
id |
integer(int64) |
partitionId |
integer(int64) |
TaskGroupTask¶
| Name | Type |
|---|---|
id |
TaskGroupTaskId |
index |
integer(int64) |
task |
CampaignContactTask |
taskGroup |
CampaignContactTaskGroup |
TaskGroupTaskId¶
| Name | Type |
|---|---|
taskGroupId |
integer(int64) |
taskId |
integer(int64) |
TAUIProduct¶
| Name | Type |
|---|---|
customUses |
Array<CustomUse> |
id |
integer(int64) |
inAnArticle |
number(double) |
mixture |
number(double) |
monomerInAPolymer |
number(double) |
notInAnArticle |
number(double) |
product |
Product |
quantityTonnes |
number(double) |
remarks |
string |
selected |
boolean |
substanceOrUnknown |
number(double) |
tonnageAndUseEnquiryProductUses |
Array<TonnageAndUseEnquiryProductUse> |
TestingLaboratory¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
clientPartition |
ClientPartition |
contacts |
Array<TestingLaboratoryContact> |
created |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
evaluationNotes |
string |
evaluations |
Array<TestingLaboratoryEvaluation> |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedById |
integer(int64) |
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
recordName |
string |
study |
Study |
studyDirectors |
Array<Contact> |
studyNumbers |
Array<StudyNumber> |
testingLaboratoryEntity |
BaseEntity |
url |
string |
TestingLaboratoryContact¶
| Name | Type |
|---|---|
contact |
Contact |
id |
integer(int64) |
role |
TestingLaboratoryRole |
testingLaboratory |
TestingLaboratory |
TestingLaboratoryEvaluation¶
| Name | Type |
|---|---|
id |
integer(int64) |
metric |
TestingLaboratoryEvaluationMetric |
score |
string |
TestingLaboratoryEvaluationMetric¶
| Name | Type |
|---|---|
id |
integer(int64) |
name |
string |
TestingLaboratoryRole¶
| Name | Type |
|---|---|
id |
integer(int64) |
name |
string |
TonnageAndUseEnquiry¶
| Name | Type |
|---|---|
accepted |
boolean |
acceptedBy |
User |
baseEntity |
BaseEntity |
clientPartition |
ClientPartition |
code |
string |
completeWithinDays |
integer(int32) |
contact |
Contact |
createdAsTonnageEnquiry |
boolean |
dateAccepted |
string(date-time) |
dateCreated |
string(date-time) |
dateSubmited |
string(date-time) |
documentEmailInternals |
Array<DocumentEmailInternal> |
documentLink |
DocumentLink |
enquiryYear |
integer(int32) |
entityRole |
EntityRole |
hidden |
boolean |
id |
integer(int64) |
includeForms |
boolean |
products |
Array<Product> |
reachLegislation |
string |
removeBracketedTextFromProductName |
boolean |
sentBy |
User |
submitted |
boolean |
submittedBy |
User |
tonnageAndUseEnquiryUploadDocuments |
Array<TonnageAndUseEnquiryUploadDocument> |
tonnageAndUseImporters |
Array<TonnageAndUseImporter> |
TonnageAndUseEnquiryProductUse¶
| Name | Type |
|---|---|
id |
integer(int64) |
puStatus |
string |
remarks |
string |
selected |
boolean |
tonnageAndUseImporter |
TonnageAndUseImporter |
usePercentage |
number(double) |
useUuid |
string(uuid) |
TonnageAndUseEnquiryUploadDocument¶
| Name | Type |
|---|---|
fileId |
string(uuid) |
fileName |
string |
id |
integer(int64) |
TonnageAndUseImporter¶
| Name | Type |
|---|---|
address |
string |
clientPartition |
ClientPartition |
contactPerson |
string |
country |
string |
email |
string |
id |
integer(int64) |
name |
string |
tauiProducts |
Array<TAUIProduct> |
taxID |
string |
telephone |
string |
UpdateOptions¶
| Name | Type |
|---|---|
campaignId |
integer(int64) |
createCampaigns |
boolean |
createContacts |
boolean |
defaultRoleId |
integer(int64) |
forCampaign |
boolean |
updateRole |
boolean |
User¶
| Name | Type |
|---|---|
active |
boolean |
breadcrumbParent |
Displayable |
calendarDashboard |
boolean |
clientPortal |
boolean |
created |
string(date-time) |
credentialsType |
string |
deleted |
boolean |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
emailAddress |
string |
enabled |
boolean |
entityGroups |
Array<EntityGroup> |
failedLoginCount |
integer(int32) |
firstName |
string |
forcePasswordChange |
boolean |
fullName |
string |
fullNameSanitized |
string |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
initials |
string |
lastLoggedIn |
string(date-time) |
lastName |
string |
lastUpdated |
string(date-time) |
lastUpdatedById |
integer(int64) |
locked |
boolean |
name |
string |
nameReversed |
string |
notActiveAfter |
string(date) |
owner |
BaseEntity |
partition |
ClientPartition |
partitionId |
integer(int64) |
passwordExpires |
string(date) |
principal |
string |
recordName |
string |
role |
Role |
secret |
string |
securityVersion |
integer(int32) |
temporaryPasswordActive |
boolean |
termsAccepted |
boolean |
url |
string |
version |
integer(int32) |
UserNotificationPreferences¶
| Name | Type |
|---|---|
allCampaignNotifications |
boolean |
allDocumentNotifications |
boolean |
allStudyNotifications |
boolean |
campaignSecurityWarnings |
boolean |
constituentsInUpdatedInventories |
boolean |
constituentTonnage |
boolean |
emails |
boolean |
invoicePayments |
boolean |
overdueInvoices |
boolean |
UserPartition¶
| Name | Type |
|---|---|
currentSelection |
boolean |
enabled |
boolean |
id |
integer(int64) |
lastUpdated |
string(date-time) |
notificationPreferences |
UserNotificationPreferences |
partition |
ClientPartition |
relevantRole |
Role |
role |
Role |
user |
User |
UseSurvey¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
campaign |
Campaign |
ceasedManufacture |
boolean |
clientPartition |
ClientPartition |
company |
string |
constituent |
Constituent |
contact |
Contact |
created |
string(date-time) |
date |
string(date) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
empty |
boolean |
entities |
Array<BaseEntity> |
entity |
BaseEntity |
event |
CampaignContactEvent |
exportedTonnage |
number |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
importedTonnage |
number |
lastUpdated |
string(date-time) |
lastUpdatedById |
integer(int64) |
name |
string |
notes |
string |
onlyRepresentative |
boolean |
orTonnage |
number |
partition |
ClientPartition |
partitionId |
integer(int64) |
recordName |
string |
referralCode |
string |
referrer |
BaseEntity |
role |
EntityRole |
status |
string |
url |
string |
useTonnages |
Array<UseSurveyTonnage> |
UseSurveyTonnage¶
| Name | Type |
|---|---|
exposureMonitored |
boolean |
functions |
Array<UseSurveyTonnageFunction> |
id |
integer(int64) |
legalEmissions |
boolean |
maxSiteTonnage |
number |
notes |
string |
proceduresDocumented |
boolean |
sdsFileIds |
Array<string(uuid)> |
sdsFileNames |
Array<string> |
tonnage |
number |
tonnageDetails |
Array<UseSurveyTonnageDetail> |
use |
string(uuid) |
useLifeCycleFallback |
string |
useNameFallback |
string |
useSurvey |
UseSurvey |
UseSurveyTonnageDetail¶
| Name | Type |
|---|---|
additionalMeasures |
Array<string> |
concentration |
number |
concentrationRange |
string |
duration |
string |
gloves |
string |
goggles |
boolean |
id |
integer(int64) |
localVentilation |
boolean |
location |
string |
masks |
string |
processCategory |
integer(int64) |
productCategory |
string |
roomVentilation |
string |
temperature |
number |
useSurveyTonnage |
UseSurveyTonnage |
UseSurveyTonnageFunction¶
| Name | Type |
|---|---|
functionId |
integer(int64) |
functionNameFallback |
string |
id |
integer(int64) |
useSurveyTonnage |
UseSurveyTonnage |