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 500 Internal Server Error
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 403 Forbidden
Response 404 Not Found
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 500 Internal Server Error
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 403 Forbidden
Response 400 Bad Request
Response 404 Not Found
DELETE /api/studies/{id}¶
Delete a Study
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 500 Internal Server Error
Response 200 OK
Response 403 Forbidden
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 500 Internal Server Error
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 403 Forbidden
Response 400 Bad Request
Response 404 Not Found
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": 239,
"totalPages": 193,
"size": 282,
"content": [
{
"id": 1,
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI"
}
],
"number": 89,
"sort": {
"empty": true,
"unsorted": true,
"sorted": true
},
"last": true,
"pageable": {
"offset": 13,
"sort": null,
"paged": true,
"unpaged": true,
"pageNumber": 44,
"pageSize": 33
},
"numberOfElements": 295,
"first": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"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"
},
"first": {
"type": "boolean"
},
"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 500 Internal Server Error
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 400 Bad Request
Response 403 Forbidden
GET /api/studies/{id}/costs¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
Registrations¶
GET /api/registrations/{id}¶
Get a Registration
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 500 Internal Server Error
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 404 Not Found
Response 403 Forbidden
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 403 Forbidden
Response 500 Internal Server Error
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 404 Not Found
Response 400 Bad Request
DELETE /api/registrations/{id}¶
Delete a Registration
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 500 Internal Server Error
Response 200 OK
Response 403 Forbidden
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 403 Forbidden
Response 500 Internal Server Error
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 404 Not Found
Response 400 Bad Request
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 200 OK
{
"totalElements": 4,
"totalPages": 138,
"size": 29,
"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": 190,
"sort": {
"empty": true,
"unsorted": true,
"sorted": true
},
"last": true,
"pageable": {
"offset": 294,
"sort": null,
"paged": true,
"unpaged": true,
"pageNumber": 282,
"pageSize": 225
},
"numberOfElements": 45,
"first": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"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"
},
"first": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
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 403 Forbidden
Response 500 Internal Server Error
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 404 Not Found
Products¶
GET /api/products/{id}¶
Get a Product
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 500 Internal Server Error
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 403 Forbidden
Response 404 Not Found
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 500 Internal Server Error
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 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
DELETE /api/products/{id}¶
Delete a Product
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 500 Internal Server Error
Response 200 OK
Response 403 Forbidden
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 500 Internal Server Error
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 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
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 200 OK
{
"totalElements": 27,
"totalPages": 276,
"size": 24,
"content": [
{
"id": 1,
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"deleted": false
}
],
"number": 161,
"sort": {
"empty": true,
"unsorted": true,
"sorted": true
},
"last": true,
"pageable": {
"offset": 51,
"sort": null,
"paged": true,
"unpaged": true,
"pageNumber": 270,
"pageSize": 170
},
"numberOfElements": 84,
"first": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"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"
},
"first": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
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 403 Forbidden
Response 500 Internal Server Error
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 400 Bad Request
Response 404 Not Found
Folders¶
GET /api/folders/{id}¶
Get a Folder
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 403 Forbidden
Response 500 Internal Server Error
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 404 Not Found
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 403 Forbidden
Response 500 Internal Server Error
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 400 Bad Request
DELETE /api/folders/{id}¶
Delete a Folder
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 500 Internal Server Error
Response 200 OK
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 403 Forbidden
Response 500 Internal Server Error
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 400 Bad Request
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 403 Forbidden
Response 200 OK
{
"totalElements": 205,
"totalPages": 124,
"size": 55,
"content": [
{
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": null
}
],
"number": 231,
"sort": {
"empty": true,
"unsorted": true,
"sorted": true
},
"last": true,
"pageable": {
"offset": 258,
"sort": null,
"paged": true,
"unpaged": true,
"pageNumber": 130,
"pageSize": 141
},
"numberOfElements": 190,
"first": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"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"
},
"first": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
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 500 Internal Server Error
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 400 Bad Request
Constituents¶
GET /api/constituents/{id}¶
Get a Constituent
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 500 Internal Server Error
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 404 Not Found
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 500 Internal Server Error
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 400 Bad Request
Response 404 Not Found
Response 403 Forbidden
DELETE /api/constituents/{id}¶
Delete a Constituent
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 500 Internal Server Error
Response 200 OK
Response 403 Forbidden
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 500 Internal Server Error
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 400 Bad Request
Response 404 Not Found
Response 403 Forbidden
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": 99,
"totalPages": 133,
"size": 109,
"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": 250,
"sort": {
"empty": true,
"unsorted": true,
"sorted": true
},
"last": true,
"pageable": {
"offset": 24,
"sort": null,
"paged": true,
"unpaged": true,
"pageNumber": 270,
"pageSize": 183
},
"numberOfElements": 254,
"first": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"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"
},
"first": {
"type": "boolean"
},
"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 500 Internal Server Error
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 400 Bad Request
Response 403 Forbidden
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 403 Forbidden
Response 200 OK
{
"totalElements": 245,
"totalPages": 53,
"size": 253,
"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": 211,
"sort": {
"empty": true,
"unsorted": true,
"sorted": true
},
"last": true,
"pageable": {
"offset": 119,
"sort": null,
"paged": true,
"unpaged": true,
"pageNumber": 1,
"pageSize": 156
},
"numberOfElements": 175,
"first": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"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"
},
"first": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
GET /api/submissions/{id}¶
Get a Submission
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 500 Internal Server Error
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
DELETE /api/submissions/{id}¶
Delete a Submission
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 403 Forbidden
Response 500 Internal Server Error
Response 200 OK
Partitions¶
GET /api/partitions¶
Get all Partitions
Response 200 OK
Response 403 Forbidden
GET /api/partitions/{id}¶
Get a Partition
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
Response 200 OK
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": 203,
"parentConstituent": 197,
"constituent": 225
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/FormulationData"
}
}
Entities¶
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": 214,
"totalPages": 21,
"size": 275,
"content": [
{
"id": 1,
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string"
}
],
"number": 113,
"sort": {
"empty": true,
"unsorted": true,
"sorted": true
},
"last": true,
"pageable": {
"offset": 182,
"sort": null,
"paged": true,
"unpaged": true,
"pageNumber": 262,
"pageSize": 7
},
"numberOfElements": 35,
"first": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"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"
},
"first": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
GET /api/entities/{id}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 404 Not Found
Response 500 Internal Server Error
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
DELETE /api/entities/{id}¶
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 403 Forbidden
Response 500 Internal Server Error
Response 200 OK
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 403 Forbidden
Response 200 OK
{
"totalElements": 212,
"totalPages": 120,
"size": 193,
"content": [
{
"id": 1,
"partitionId": 100,
"name": "2025-31-01 Benzene CSR",
"type": "CSR",
"documentCreationDate": "2025-31-01"
}
],
"number": 296,
"sort": {
"empty": true,
"unsorted": true,
"sorted": true
},
"last": true,
"pageable": {
"offset": 111,
"sort": null,
"paged": true,
"unpaged": true,
"pageNumber": 171,
"pageSize": 43
},
"numberOfElements": 22,
"first": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"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"
},
"first": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
GET /api/documents/{id}¶
Get a Document
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 403 Forbidden
Response 500 Internal Server Error
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 404 Not Found
DELETE /api/documents/{id}¶
Delete a Document
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 403 Forbidden
Response 500 Internal Server Error
Response 200 OK
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 403 Forbidden
Response 200 OK
{
"totalElements": 22,
"totalPages": 294,
"size": 65,
"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": 245,
"sort": {
"empty": true,
"unsorted": true,
"sorted": true
},
"last": true,
"pageable": {
"offset": 158,
"sort": null,
"paged": true,
"unpaged": true,
"pageNumber": 119,
"pageSize": 199
},
"numberOfElements": 232,
"first": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"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"
},
"first": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
GET /api/contacts/{id}¶
Get a Contact
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
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"
]
}
DELETE /api/contacts/{id}¶
Delete a Contact
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 403 Forbidden
Response 500 Internal Server Error
Response 200 OK
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 403 Forbidden
Response 200 OK
{
"totalElements": 54,
"totalPages": 181,
"size": 87,
"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": 58,
"sort": {
"empty": true,
"unsorted": true,
"sorted": true
},
"last": true,
"pageable": {
"offset": 114,
"sort": null,
"paged": true,
"unpaged": true,
"pageNumber": 270,
"pageSize": 129
},
"numberOfElements": 35,
"first": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"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"
},
"first": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
GET /api/budgets/{id}¶
Get a Budget
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
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"
]
}
DELETE /api/budgets/{id}¶
Delete a Budget
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 403 Forbidden
Response 500 Internal Server Error
Response 200 OK
Schemas¶
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) |
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 |
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 |
DocumentData¶
| Name | Type |
|---|---|
documentCreationDate |
string(date) |
id |
integer(int64) |
name |
string |
partitionId |
integer(int64) |
type |
string |
EntityData¶
| Name | Type |
|---|---|
companyNo |
string |
dunnNo |
string |
id |
integer(int64) |
name |
string |
partitionId |
integer(int64) |
utr |
string |
vatNo |
string |
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 |
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) |
ProductData¶
| Name | Type |
|---|---|
deleted |
boolean |
id |
integer(int64) |
name |
string |
ownerManufacturer |
string |
partitionId |
integer(int64) |
RegistrationData¶
| Name | Type |
|---|---|
constituent |
ConstituentData |
id |
integer(int64) |
reachLegislation |
string |
registrationDate |
string(date) |
registrationName |
string |
registrationNumber |
string |
SortObject¶
| Name | Type |
|---|---|
empty |
boolean |
sorted |
boolean |
unsorted |
boolean |
StudyData¶
| Name | Type |
|---|---|
end |
string(date) |
id |
integer(int64) |
name |
string |
partitionId |
integer(int64) |
purpose |
string |
start |
string(date) |
status |
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 |