Active Steward API 1.1¶
1.1: a composition item's type is an open code string (was a fixed enum); the codes valid on this instance come from GET /api/constituent-types.
Servers¶
| Description | URL |
|---|---|
| Your Company's Active Steward Instance | /ActiveSteward |
Submissions¶
GET /api/submissions/{id}¶
Get a Submission
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"registration": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"reachLegislation": "EU_REACH",
"type": "INTERNAL",
"submittingLegalEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"forLegalEntity": null,
"forLegalEntityUuid": "37b58a8c-fae4-485f-bb99-1cf879d34678",
"status": "ACTIVE",
"registrationName": "Calcium dihydroxide",
"registrationNumber": "01-2119475151-45-1000",
"registrationDate": "2022-04-13",
"registrationRole": "MEMBER",
"annex": "VIII",
"publicName": "Calcium dihydroxide",
"reachRole": "MANUFACTURER",
"enquiryNumber": "06-1111111111-11-1111",
"ppordNumber": "04-1111111111-11-1111",
"iuclidUUID": "U37b58a8c-fae4-485f-bb99-1cf666d34678",
"registrationNotes": "Registration is complete.",
"reachDossierType": "A",
"preregistered": true,
"preregistrationName": "Calcium dihydroxide",
"preregistrationNumber": "05-1122334455-66-0001",
"preregistrationDate": "2022-04-13",
"preregistrationNote": "Preregistration complete.",
"exempt": true,
"exemptionType": "ANNEXIV",
"exemption": "dangerous",
"exemptionComment": "Marked as Exempt.",
"effectiveAnnex": "VIII"
},
"dateSubmitted": "2022-04-13",
"dateIssued": "2022-04-13",
"dateAccepted": "2022-04-13",
"reachDossierType": "AU_IND_CHEM_ASSESS",
"tonnageBand": "BAND3",
"registeredTonnageBand": "BAND_2",
"reason": "INITIAL",
"notes": "string",
"iuclidDossierReference": "string",
"communicationReference": "string",
"submissionNumber": "string",
"status": "SUBMITTED"
}
Schema of the response body
{
"required": [
"registration"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"registration": {
"$ref": "#/components/schemas/RegistrationData"
},
"dateSubmitted": {
"type": "string",
"format": "date"
},
"dateIssued": {
"type": "string",
"format": "date"
},
"dateAccepted": {
"type": "string",
"format": "date"
},
"reachDossierType": {
"type": "string",
"enum": [
"AU_IND_CHEM_ASSESS",
"AU_IND_CHEM_CERT_APPL_T1",
"AU_IND_CHEM_CERT_APPL_T2",
"AU_IND_CHEM_CERT_APPL_T3",
"AU_IND_CHEM_CERT_APPL_T4",
"AU_IND_CHEM_CERT_APPL_T5",
"AU_IND_CHEM_CEA",
"AU_IND_CHEM_PIR",
"BIOC_ACTIVE_SUBSTANCE_FOR_SUBSTANCES",
"BIOC_BASIC_INFORMATION",
"BIOC_BIOCIDAL_PRODUCT",
"BIOC_MICRO",
"BIOC_SUBSTANCE_OF_CONCERN",
"BIOC_SPC",
"BIOC_TECHNICAL_EQUIVALENCE",
"CLP_ALTERNATIVE_NAME",
"CLP_NOTIF",
"CLP_CLH",
"CLP_PCN_ICG",
"CLP_PCN_SFC",
"CLP_PCN",
"R_A15_SVHC",
"R_A15_REST",
"R_AUTH_APPL",
"R_DU_REPORT",
"R_SIA_NOTIF",
"R_1_10_PC",
"R_1_10_STD",
"R_10_100",
"R_100_1000",
"R_ABOVE_1000",
"R_JS_MBER",
"R_INT_JS_MBER",
"R_INT_ONSITE",
"R_INT_ONSITE_1_1000",
"R_INT_ONSITE_ABOVE_1000",
"R_SUB_EVAL",
"R_PPORD",
"R_INQUIRY",
"BIOC_ACTIVE_SUBSTANCE_FOR_MIXTURES",
"R_INT_TR_1_1000",
"R_INT_TR_ABOVE_1000",
"R_DU_NOTIF",
"R_MICROPLASTICS",
"DWD_ARTICLE_11_APPL",
"DWD_NIAS_OR_OTHER_SUBSTANCE",
"DWD_NOTIF",
"FCM_APPL",
"FCM_NIAS",
"EU_PPP_ACTIVE_SUBSTANCE_APP",
"EU_PPP_CA_ACTIVE_SUBSTANCE",
"EU_PPP_BASIC_SUBSTANCE",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS",
"EU_PPP_MICRO",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS_ACTIVE",
"EU_PPP_OTHER_MIXTURE",
"EU_PPP_OTHER_SUBSTANCE_ASSESSED",
"EU_PPP_PESTICIDE_PRODUCT",
"EU_PPP_SAFENERS_SYN_APP",
"EU_TSR_DEROGATION",
"K_REACH_INQUIRY",
"K_REACH_POLYMER_EXEMPTION",
"K_REACH_REAGENT_EXEMPTION",
"K_REACH_RD_EXEMPTION",
"K_REACH_EXPORT_EXEMPTION",
"K_REACH_SURFACE_TREATED_EXEMPTION",
"K_REACH_NON_ISOLATED_INT_EXEMPTION",
"K_REACH_ONSITE_INT_EXEMPTION",
"K_REACH_01_1",
"K_REACH_1_10",
"K_REACH_10_100",
"K_REACH_100_1000",
"K_REACH_ABOVE_1000",
"K_REACH_POLYMER_01_1",
"K_REACH_POLYMER_1_10",
"K_REACH_POLYMER_10_100",
"K_REACH_POLYMER_100_1000",
"K_REACH_POLYMER_ABOVE_1000",
"K_REACH_INT_ONSITE_01_1",
"K_REACH_INT_ONSITE_1_10",
"K_REACH_INT_ONSITE_10_100",
"K_REACH_INT_ONSITE_100_1000",
"K_REACH_INT_ONSITE_ABOVE_1000",
"K_REACH_INT_TR_01_1",
"K_REACH_INT_TR_1_10",
"K_REACH_INT_TR_10_100",
"K_REACH_INT_TR_100_1000",
"K_REACH_INT_TR_ABOVE_1000",
"K_REACH_EXEMPTION_CERT",
"K_REACH_REGISTRATION_CERT",
"K_REACH_HAZARD_EVAL",
"K_REACH_DU_REPORT",
"NZ_HSNO_APPL_FULL_ASSESS_CAT",
"NZ_HSNO_FULL_ASSESS_CAT",
"NZ_HSNO_LMTD_ASSESS_CAT",
"OECD_SIDS",
"OECD_HT_CAT"
]
},
"tonnageBand": {
"type": "string",
"description": "The size of the submitted tonnage band. On input it is ignored when registeredTonnageBand is given (and must then be its size); otherwise it is stored as the registration's current band of that size, or else the legislation's standard band of that size",
"example": "BAND3",
"enum": [
"BAND1",
"BAND2",
"BAND3",
"BAND4",
"BAND5"
]
},
"registeredTonnageBand": {
"type": "string",
"description": "The submitted tonnage band, which must be one of the registration's legislation. Takes precedence over tonnageBand",
"example": "BAND_2",
"enum": [
"BAND_1",
"BAND_2",
"BAND_3",
"BAND_4",
"BAND_5",
"BAND_6",
"BAND_7",
"BAND_8",
"BAND_9",
"BAND_K_1",
"BAND_K_2",
"BAND_K_3",
"BAND_K_4",
"BAND_K_5",
"BAND_K_6",
"BAND_K_7",
"BAND_K_8",
"BAND_K_9",
"BAND_K_10",
"BAND_K_11",
"BAND_K_12",
"BAND_K_13",
"BAND_K_14",
"BAND_K_15",
"BAND_K_16",
"BAND_K_17",
"BAND_K_18",
"BAND_K_19",
"BAND_K_20",
"CEASE_OF_MANUFACTURE"
]
},
"reason": {
"type": "string",
"example": "INITIAL",
"enum": [
"CEASE_OF_MANUFACTURE",
"GRANDFATHERING",
"INITIAL",
"INQUIRY",
"REQUESTED",
"UPDATE_SPONTANEOUS"
]
},
"notes": {
"type": "string"
},
"iuclidDossierReference": {
"type": "string"
},
"communicationReference": {
"type": "string"
},
"submissionNumber": {
"type": "string"
},
"status": {
"type": "string",
"description": "Required, except for a CEASE_OF_MANUFACTURE reason, which never has a status",
"example": "SUBMITTED",
"enum": [
"DRAFT",
"SUBMITTED",
"ACCEPTED",
"REJECTED"
]
}
}
}
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
PUT /api/submissions/{id}¶
Update a Submission
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"registration": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"reachLegislation": "EU_REACH",
"type": "INTERNAL",
"submittingLegalEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"forLegalEntity": null,
"forLegalEntityUuid": "37b58a8c-fae4-485f-bb99-1cf879d34678",
"status": "ACTIVE",
"registrationName": "Calcium dihydroxide",
"registrationNumber": "01-2119475151-45-1000",
"registrationDate": "2022-04-13",
"registrationRole": "MEMBER",
"annex": "VIII",
"publicName": "Calcium dihydroxide",
"reachRole": "MANUFACTURER",
"enquiryNumber": "06-1111111111-11-1111",
"ppordNumber": "04-1111111111-11-1111",
"iuclidUUID": "U37b58a8c-fae4-485f-bb99-1cf666d34678",
"registrationNotes": "Registration is complete.",
"reachDossierType": "A",
"preregistered": true,
"preregistrationName": "Calcium dihydroxide",
"preregistrationNumber": "05-1122334455-66-0001",
"preregistrationDate": "2022-04-13",
"preregistrationNote": "Preregistration complete.",
"exempt": true,
"exemptionType": "ANNEXIV",
"exemption": "dangerous",
"exemptionComment": "Marked as Exempt.",
"effectiveAnnex": "VIII"
},
"dateSubmitted": "2022-04-13",
"dateIssued": "2022-04-13",
"dateAccepted": "2022-04-13",
"reachDossierType": "AU_IND_CHEM_ASSESS",
"tonnageBand": "BAND3",
"registeredTonnageBand": "BAND_2",
"reason": "INITIAL",
"notes": "string",
"iuclidDossierReference": "string",
"communicationReference": "string",
"submissionNumber": "string",
"status": "SUBMITTED"
}
Schema of the request body
{
"required": [
"registration"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"registration": {
"$ref": "#/components/schemas/RegistrationData"
},
"dateSubmitted": {
"type": "string",
"format": "date"
},
"dateIssued": {
"type": "string",
"format": "date"
},
"dateAccepted": {
"type": "string",
"format": "date"
},
"reachDossierType": {
"type": "string",
"enum": [
"AU_IND_CHEM_ASSESS",
"AU_IND_CHEM_CERT_APPL_T1",
"AU_IND_CHEM_CERT_APPL_T2",
"AU_IND_CHEM_CERT_APPL_T3",
"AU_IND_CHEM_CERT_APPL_T4",
"AU_IND_CHEM_CERT_APPL_T5",
"AU_IND_CHEM_CEA",
"AU_IND_CHEM_PIR",
"BIOC_ACTIVE_SUBSTANCE_FOR_SUBSTANCES",
"BIOC_BASIC_INFORMATION",
"BIOC_BIOCIDAL_PRODUCT",
"BIOC_MICRO",
"BIOC_SUBSTANCE_OF_CONCERN",
"BIOC_SPC",
"BIOC_TECHNICAL_EQUIVALENCE",
"CLP_ALTERNATIVE_NAME",
"CLP_NOTIF",
"CLP_CLH",
"CLP_PCN_ICG",
"CLP_PCN_SFC",
"CLP_PCN",
"R_A15_SVHC",
"R_A15_REST",
"R_AUTH_APPL",
"R_DU_REPORT",
"R_SIA_NOTIF",
"R_1_10_PC",
"R_1_10_STD",
"R_10_100",
"R_100_1000",
"R_ABOVE_1000",
"R_JS_MBER",
"R_INT_JS_MBER",
"R_INT_ONSITE",
"R_INT_ONSITE_1_1000",
"R_INT_ONSITE_ABOVE_1000",
"R_SUB_EVAL",
"R_PPORD",
"R_INQUIRY",
"BIOC_ACTIVE_SUBSTANCE_FOR_MIXTURES",
"R_INT_TR_1_1000",
"R_INT_TR_ABOVE_1000",
"R_DU_NOTIF",
"R_MICROPLASTICS",
"DWD_ARTICLE_11_APPL",
"DWD_NIAS_OR_OTHER_SUBSTANCE",
"DWD_NOTIF",
"FCM_APPL",
"FCM_NIAS",
"EU_PPP_ACTIVE_SUBSTANCE_APP",
"EU_PPP_CA_ACTIVE_SUBSTANCE",
"EU_PPP_BASIC_SUBSTANCE",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS",
"EU_PPP_MICRO",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS_ACTIVE",
"EU_PPP_OTHER_MIXTURE",
"EU_PPP_OTHER_SUBSTANCE_ASSESSED",
"EU_PPP_PESTICIDE_PRODUCT",
"EU_PPP_SAFENERS_SYN_APP",
"EU_TSR_DEROGATION",
"K_REACH_INQUIRY",
"K_REACH_POLYMER_EXEMPTION",
"K_REACH_REAGENT_EXEMPTION",
"K_REACH_RD_EXEMPTION",
"K_REACH_EXPORT_EXEMPTION",
"K_REACH_SURFACE_TREATED_EXEMPTION",
"K_REACH_NON_ISOLATED_INT_EXEMPTION",
"K_REACH_ONSITE_INT_EXEMPTION",
"K_REACH_01_1",
"K_REACH_1_10",
"K_REACH_10_100",
"K_REACH_100_1000",
"K_REACH_ABOVE_1000",
"K_REACH_POLYMER_01_1",
"K_REACH_POLYMER_1_10",
"K_REACH_POLYMER_10_100",
"K_REACH_POLYMER_100_1000",
"K_REACH_POLYMER_ABOVE_1000",
"K_REACH_INT_ONSITE_01_1",
"K_REACH_INT_ONSITE_1_10",
"K_REACH_INT_ONSITE_10_100",
"K_REACH_INT_ONSITE_100_1000",
"K_REACH_INT_ONSITE_ABOVE_1000",
"K_REACH_INT_TR_01_1",
"K_REACH_INT_TR_1_10",
"K_REACH_INT_TR_10_100",
"K_REACH_INT_TR_100_1000",
"K_REACH_INT_TR_ABOVE_1000",
"K_REACH_EXEMPTION_CERT",
"K_REACH_REGISTRATION_CERT",
"K_REACH_HAZARD_EVAL",
"K_REACH_DU_REPORT",
"NZ_HSNO_APPL_FULL_ASSESS_CAT",
"NZ_HSNO_FULL_ASSESS_CAT",
"NZ_HSNO_LMTD_ASSESS_CAT",
"OECD_SIDS",
"OECD_HT_CAT"
]
},
"tonnageBand": {
"type": "string",
"description": "The size of the submitted tonnage band. On input it is ignored when registeredTonnageBand is given (and must then be its size); otherwise it is stored as the registration's current band of that size, or else the legislation's standard band of that size",
"example": "BAND3",
"enum": [
"BAND1",
"BAND2",
"BAND3",
"BAND4",
"BAND5"
]
},
"registeredTonnageBand": {
"type": "string",
"description": "The submitted tonnage band, which must be one of the registration's legislation. Takes precedence over tonnageBand",
"example": "BAND_2",
"enum": [
"BAND_1",
"BAND_2",
"BAND_3",
"BAND_4",
"BAND_5",
"BAND_6",
"BAND_7",
"BAND_8",
"BAND_9",
"BAND_K_1",
"BAND_K_2",
"BAND_K_3",
"BAND_K_4",
"BAND_K_5",
"BAND_K_6",
"BAND_K_7",
"BAND_K_8",
"BAND_K_9",
"BAND_K_10",
"BAND_K_11",
"BAND_K_12",
"BAND_K_13",
"BAND_K_14",
"BAND_K_15",
"BAND_K_16",
"BAND_K_17",
"BAND_K_18",
"BAND_K_19",
"BAND_K_20",
"CEASE_OF_MANUFACTURE"
]
},
"reason": {
"type": "string",
"example": "INITIAL",
"enum": [
"CEASE_OF_MANUFACTURE",
"GRANDFATHERING",
"INITIAL",
"INQUIRY",
"REQUESTED",
"UPDATE_SPONTANEOUS"
]
},
"notes": {
"type": "string"
},
"iuclidDossierReference": {
"type": "string"
},
"communicationReference": {
"type": "string"
},
"submissionNumber": {
"type": "string"
},
"status": {
"type": "string",
"description": "Required, except for a CEASE_OF_MANUFACTURE reason, which never has a status",
"example": "SUBMITTED",
"enum": [
"DRAFT",
"SUBMITTED",
"ACCEPTED",
"REJECTED"
]
}
}
}
Response 204 No Content
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"registration": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"reachLegislation": "EU_REACH",
"type": "INTERNAL",
"submittingLegalEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"forLegalEntity": null,
"forLegalEntityUuid": "37b58a8c-fae4-485f-bb99-1cf879d34678",
"status": "ACTIVE",
"registrationName": "Calcium dihydroxide",
"registrationNumber": "01-2119475151-45-1000",
"registrationDate": "2022-04-13",
"registrationRole": "MEMBER",
"annex": "VIII",
"publicName": "Calcium dihydroxide",
"reachRole": "MANUFACTURER",
"enquiryNumber": "06-1111111111-11-1111",
"ppordNumber": "04-1111111111-11-1111",
"iuclidUUID": "U37b58a8c-fae4-485f-bb99-1cf666d34678",
"registrationNotes": "Registration is complete.",
"reachDossierType": "A",
"preregistered": true,
"preregistrationName": "Calcium dihydroxide",
"preregistrationNumber": "05-1122334455-66-0001",
"preregistrationDate": "2022-04-13",
"preregistrationNote": "Preregistration complete.",
"exempt": true,
"exemptionType": "ANNEXIV",
"exemption": "dangerous",
"exemptionComment": "Marked as Exempt.",
"effectiveAnnex": "VIII"
},
"dateSubmitted": "2022-04-13",
"dateIssued": "2022-04-13",
"dateAccepted": "2022-04-13",
"reachDossierType": "AU_IND_CHEM_ASSESS",
"tonnageBand": "BAND3",
"registeredTonnageBand": "BAND_2",
"reason": "INITIAL",
"notes": "string",
"iuclidDossierReference": "string",
"communicationReference": "string",
"submissionNumber": "string",
"status": "SUBMITTED"
}
Schema of the response body
{
"required": [
"registration"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"registration": {
"$ref": "#/components/schemas/RegistrationData"
},
"dateSubmitted": {
"type": "string",
"format": "date"
},
"dateIssued": {
"type": "string",
"format": "date"
},
"dateAccepted": {
"type": "string",
"format": "date"
},
"reachDossierType": {
"type": "string",
"enum": [
"AU_IND_CHEM_ASSESS",
"AU_IND_CHEM_CERT_APPL_T1",
"AU_IND_CHEM_CERT_APPL_T2",
"AU_IND_CHEM_CERT_APPL_T3",
"AU_IND_CHEM_CERT_APPL_T4",
"AU_IND_CHEM_CERT_APPL_T5",
"AU_IND_CHEM_CEA",
"AU_IND_CHEM_PIR",
"BIOC_ACTIVE_SUBSTANCE_FOR_SUBSTANCES",
"BIOC_BASIC_INFORMATION",
"BIOC_BIOCIDAL_PRODUCT",
"BIOC_MICRO",
"BIOC_SUBSTANCE_OF_CONCERN",
"BIOC_SPC",
"BIOC_TECHNICAL_EQUIVALENCE",
"CLP_ALTERNATIVE_NAME",
"CLP_NOTIF",
"CLP_CLH",
"CLP_PCN_ICG",
"CLP_PCN_SFC",
"CLP_PCN",
"R_A15_SVHC",
"R_A15_REST",
"R_AUTH_APPL",
"R_DU_REPORT",
"R_SIA_NOTIF",
"R_1_10_PC",
"R_1_10_STD",
"R_10_100",
"R_100_1000",
"R_ABOVE_1000",
"R_JS_MBER",
"R_INT_JS_MBER",
"R_INT_ONSITE",
"R_INT_ONSITE_1_1000",
"R_INT_ONSITE_ABOVE_1000",
"R_SUB_EVAL",
"R_PPORD",
"R_INQUIRY",
"BIOC_ACTIVE_SUBSTANCE_FOR_MIXTURES",
"R_INT_TR_1_1000",
"R_INT_TR_ABOVE_1000",
"R_DU_NOTIF",
"R_MICROPLASTICS",
"DWD_ARTICLE_11_APPL",
"DWD_NIAS_OR_OTHER_SUBSTANCE",
"DWD_NOTIF",
"FCM_APPL",
"FCM_NIAS",
"EU_PPP_ACTIVE_SUBSTANCE_APP",
"EU_PPP_CA_ACTIVE_SUBSTANCE",
"EU_PPP_BASIC_SUBSTANCE",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS",
"EU_PPP_MICRO",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS_ACTIVE",
"EU_PPP_OTHER_MIXTURE",
"EU_PPP_OTHER_SUBSTANCE_ASSESSED",
"EU_PPP_PESTICIDE_PRODUCT",
"EU_PPP_SAFENERS_SYN_APP",
"EU_TSR_DEROGATION",
"K_REACH_INQUIRY",
"K_REACH_POLYMER_EXEMPTION",
"K_REACH_REAGENT_EXEMPTION",
"K_REACH_RD_EXEMPTION",
"K_REACH_EXPORT_EXEMPTION",
"K_REACH_SURFACE_TREATED_EXEMPTION",
"K_REACH_NON_ISOLATED_INT_EXEMPTION",
"K_REACH_ONSITE_INT_EXEMPTION",
"K_REACH_01_1",
"K_REACH_1_10",
"K_REACH_10_100",
"K_REACH_100_1000",
"K_REACH_ABOVE_1000",
"K_REACH_POLYMER_01_1",
"K_REACH_POLYMER_1_10",
"K_REACH_POLYMER_10_100",
"K_REACH_POLYMER_100_1000",
"K_REACH_POLYMER_ABOVE_1000",
"K_REACH_INT_ONSITE_01_1",
"K_REACH_INT_ONSITE_1_10",
"K_REACH_INT_ONSITE_10_100",
"K_REACH_INT_ONSITE_100_1000",
"K_REACH_INT_ONSITE_ABOVE_1000",
"K_REACH_INT_TR_01_1",
"K_REACH_INT_TR_1_10",
"K_REACH_INT_TR_10_100",
"K_REACH_INT_TR_100_1000",
"K_REACH_INT_TR_ABOVE_1000",
"K_REACH_EXEMPTION_CERT",
"K_REACH_REGISTRATION_CERT",
"K_REACH_HAZARD_EVAL",
"K_REACH_DU_REPORT",
"NZ_HSNO_APPL_FULL_ASSESS_CAT",
"NZ_HSNO_FULL_ASSESS_CAT",
"NZ_HSNO_LMTD_ASSESS_CAT",
"OECD_SIDS",
"OECD_HT_CAT"
]
},
"tonnageBand": {
"type": "string",
"description": "The size of the submitted tonnage band. On input it is ignored when registeredTonnageBand is given (and must then be its size); otherwise it is stored as the registration's current band of that size, or else the legislation's standard band of that size",
"example": "BAND3",
"enum": [
"BAND1",
"BAND2",
"BAND3",
"BAND4",
"BAND5"
]
},
"registeredTonnageBand": {
"type": "string",
"description": "The submitted tonnage band, which must be one of the registration's legislation. Takes precedence over tonnageBand",
"example": "BAND_2",
"enum": [
"BAND_1",
"BAND_2",
"BAND_3",
"BAND_4",
"BAND_5",
"BAND_6",
"BAND_7",
"BAND_8",
"BAND_9",
"BAND_K_1",
"BAND_K_2",
"BAND_K_3",
"BAND_K_4",
"BAND_K_5",
"BAND_K_6",
"BAND_K_7",
"BAND_K_8",
"BAND_K_9",
"BAND_K_10",
"BAND_K_11",
"BAND_K_12",
"BAND_K_13",
"BAND_K_14",
"BAND_K_15",
"BAND_K_16",
"BAND_K_17",
"BAND_K_18",
"BAND_K_19",
"BAND_K_20",
"CEASE_OF_MANUFACTURE"
]
},
"reason": {
"type": "string",
"example": "INITIAL",
"enum": [
"CEASE_OF_MANUFACTURE",
"GRANDFATHERING",
"INITIAL",
"INQUIRY",
"REQUESTED",
"UPDATE_SPONTANEOUS"
]
},
"notes": {
"type": "string"
},
"iuclidDossierReference": {
"type": "string"
},
"communicationReference": {
"type": "string"
},
"submissionNumber": {
"type": "string"
},
"status": {
"type": "string",
"description": "Required, except for a CEASE_OF_MANUFACTURE reason, which never has a status",
"example": "SUBMITTED",
"enum": [
"DRAFT",
"SUBMITTED",
"ACCEPTED",
"REJECTED"
]
}
}
}
Response 403 Forbidden
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
PATCH /api/submissions/{id}¶
Partially update a Submission
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"registration": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"reachLegislation": "EU_REACH",
"type": "INTERNAL",
"submittingLegalEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"forLegalEntity": null,
"forLegalEntityUuid": "37b58a8c-fae4-485f-bb99-1cf879d34678",
"status": "ACTIVE",
"registrationName": "Calcium dihydroxide",
"registrationNumber": "01-2119475151-45-1000",
"registrationDate": "2022-04-13",
"registrationRole": "MEMBER",
"annex": "VIII",
"publicName": "Calcium dihydroxide",
"reachRole": "MANUFACTURER",
"enquiryNumber": "06-1111111111-11-1111",
"ppordNumber": "04-1111111111-11-1111",
"iuclidUUID": "U37b58a8c-fae4-485f-bb99-1cf666d34678",
"registrationNotes": "Registration is complete.",
"reachDossierType": "A",
"preregistered": true,
"preregistrationName": "Calcium dihydroxide",
"preregistrationNumber": "05-1122334455-66-0001",
"preregistrationDate": "2022-04-13",
"preregistrationNote": "Preregistration complete.",
"exempt": true,
"exemptionType": "ANNEXIV",
"exemption": "dangerous",
"exemptionComment": "Marked as Exempt.",
"effectiveAnnex": "VIII"
},
"dateSubmitted": "2022-04-13",
"dateIssued": "2022-04-13",
"dateAccepted": "2022-04-13",
"reachDossierType": "AU_IND_CHEM_ASSESS",
"tonnageBand": "BAND3",
"registeredTonnageBand": "BAND_2",
"reason": "INITIAL",
"notes": "string",
"iuclidDossierReference": "string",
"communicationReference": "string",
"submissionNumber": "string",
"status": "SUBMITTED"
}
Schema of the request body
{
"required": [
"registration"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"registration": {
"$ref": "#/components/schemas/RegistrationData"
},
"dateSubmitted": {
"type": "string",
"format": "date"
},
"dateIssued": {
"type": "string",
"format": "date"
},
"dateAccepted": {
"type": "string",
"format": "date"
},
"reachDossierType": {
"type": "string",
"enum": [
"AU_IND_CHEM_ASSESS",
"AU_IND_CHEM_CERT_APPL_T1",
"AU_IND_CHEM_CERT_APPL_T2",
"AU_IND_CHEM_CERT_APPL_T3",
"AU_IND_CHEM_CERT_APPL_T4",
"AU_IND_CHEM_CERT_APPL_T5",
"AU_IND_CHEM_CEA",
"AU_IND_CHEM_PIR",
"BIOC_ACTIVE_SUBSTANCE_FOR_SUBSTANCES",
"BIOC_BASIC_INFORMATION",
"BIOC_BIOCIDAL_PRODUCT",
"BIOC_MICRO",
"BIOC_SUBSTANCE_OF_CONCERN",
"BIOC_SPC",
"BIOC_TECHNICAL_EQUIVALENCE",
"CLP_ALTERNATIVE_NAME",
"CLP_NOTIF",
"CLP_CLH",
"CLP_PCN_ICG",
"CLP_PCN_SFC",
"CLP_PCN",
"R_A15_SVHC",
"R_A15_REST",
"R_AUTH_APPL",
"R_DU_REPORT",
"R_SIA_NOTIF",
"R_1_10_PC",
"R_1_10_STD",
"R_10_100",
"R_100_1000",
"R_ABOVE_1000",
"R_JS_MBER",
"R_INT_JS_MBER",
"R_INT_ONSITE",
"R_INT_ONSITE_1_1000",
"R_INT_ONSITE_ABOVE_1000",
"R_SUB_EVAL",
"R_PPORD",
"R_INQUIRY",
"BIOC_ACTIVE_SUBSTANCE_FOR_MIXTURES",
"R_INT_TR_1_1000",
"R_INT_TR_ABOVE_1000",
"R_DU_NOTIF",
"R_MICROPLASTICS",
"DWD_ARTICLE_11_APPL",
"DWD_NIAS_OR_OTHER_SUBSTANCE",
"DWD_NOTIF",
"FCM_APPL",
"FCM_NIAS",
"EU_PPP_ACTIVE_SUBSTANCE_APP",
"EU_PPP_CA_ACTIVE_SUBSTANCE",
"EU_PPP_BASIC_SUBSTANCE",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS",
"EU_PPP_MICRO",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS_ACTIVE",
"EU_PPP_OTHER_MIXTURE",
"EU_PPP_OTHER_SUBSTANCE_ASSESSED",
"EU_PPP_PESTICIDE_PRODUCT",
"EU_PPP_SAFENERS_SYN_APP",
"EU_TSR_DEROGATION",
"K_REACH_INQUIRY",
"K_REACH_POLYMER_EXEMPTION",
"K_REACH_REAGENT_EXEMPTION",
"K_REACH_RD_EXEMPTION",
"K_REACH_EXPORT_EXEMPTION",
"K_REACH_SURFACE_TREATED_EXEMPTION",
"K_REACH_NON_ISOLATED_INT_EXEMPTION",
"K_REACH_ONSITE_INT_EXEMPTION",
"K_REACH_01_1",
"K_REACH_1_10",
"K_REACH_10_100",
"K_REACH_100_1000",
"K_REACH_ABOVE_1000",
"K_REACH_POLYMER_01_1",
"K_REACH_POLYMER_1_10",
"K_REACH_POLYMER_10_100",
"K_REACH_POLYMER_100_1000",
"K_REACH_POLYMER_ABOVE_1000",
"K_REACH_INT_ONSITE_01_1",
"K_REACH_INT_ONSITE_1_10",
"K_REACH_INT_ONSITE_10_100",
"K_REACH_INT_ONSITE_100_1000",
"K_REACH_INT_ONSITE_ABOVE_1000",
"K_REACH_INT_TR_01_1",
"K_REACH_INT_TR_1_10",
"K_REACH_INT_TR_10_100",
"K_REACH_INT_TR_100_1000",
"K_REACH_INT_TR_ABOVE_1000",
"K_REACH_EXEMPTION_CERT",
"K_REACH_REGISTRATION_CERT",
"K_REACH_HAZARD_EVAL",
"K_REACH_DU_REPORT",
"NZ_HSNO_APPL_FULL_ASSESS_CAT",
"NZ_HSNO_FULL_ASSESS_CAT",
"NZ_HSNO_LMTD_ASSESS_CAT",
"OECD_SIDS",
"OECD_HT_CAT"
]
},
"tonnageBand": {
"type": "string",
"description": "The size of the submitted tonnage band. On input it is ignored when registeredTonnageBand is given (and must then be its size); otherwise it is stored as the registration's current band of that size, or else the legislation's standard band of that size",
"example": "BAND3",
"enum": [
"BAND1",
"BAND2",
"BAND3",
"BAND4",
"BAND5"
]
},
"registeredTonnageBand": {
"type": "string",
"description": "The submitted tonnage band, which must be one of the registration's legislation. Takes precedence over tonnageBand",
"example": "BAND_2",
"enum": [
"BAND_1",
"BAND_2",
"BAND_3",
"BAND_4",
"BAND_5",
"BAND_6",
"BAND_7",
"BAND_8",
"BAND_9",
"BAND_K_1",
"BAND_K_2",
"BAND_K_3",
"BAND_K_4",
"BAND_K_5",
"BAND_K_6",
"BAND_K_7",
"BAND_K_8",
"BAND_K_9",
"BAND_K_10",
"BAND_K_11",
"BAND_K_12",
"BAND_K_13",
"BAND_K_14",
"BAND_K_15",
"BAND_K_16",
"BAND_K_17",
"BAND_K_18",
"BAND_K_19",
"BAND_K_20",
"CEASE_OF_MANUFACTURE"
]
},
"reason": {
"type": "string",
"example": "INITIAL",
"enum": [
"CEASE_OF_MANUFACTURE",
"GRANDFATHERING",
"INITIAL",
"INQUIRY",
"REQUESTED",
"UPDATE_SPONTANEOUS"
]
},
"notes": {
"type": "string"
},
"iuclidDossierReference": {
"type": "string"
},
"communicationReference": {
"type": "string"
},
"submissionNumber": {
"type": "string"
},
"status": {
"type": "string",
"description": "Required, except for a CEASE_OF_MANUFACTURE reason, which never has a status",
"example": "SUBMITTED",
"enum": [
"DRAFT",
"SUBMITTED",
"ACCEPTED",
"REJECTED"
]
}
}
}
Response 204 No Content
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"registration": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"reachLegislation": "EU_REACH",
"type": "INTERNAL",
"submittingLegalEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"forLegalEntity": null,
"forLegalEntityUuid": "37b58a8c-fae4-485f-bb99-1cf879d34678",
"status": "ACTIVE",
"registrationName": "Calcium dihydroxide",
"registrationNumber": "01-2119475151-45-1000",
"registrationDate": "2022-04-13",
"registrationRole": "MEMBER",
"annex": "VIII",
"publicName": "Calcium dihydroxide",
"reachRole": "MANUFACTURER",
"enquiryNumber": "06-1111111111-11-1111",
"ppordNumber": "04-1111111111-11-1111",
"iuclidUUID": "U37b58a8c-fae4-485f-bb99-1cf666d34678",
"registrationNotes": "Registration is complete.",
"reachDossierType": "A",
"preregistered": true,
"preregistrationName": "Calcium dihydroxide",
"preregistrationNumber": "05-1122334455-66-0001",
"preregistrationDate": "2022-04-13",
"preregistrationNote": "Preregistration complete.",
"exempt": true,
"exemptionType": "ANNEXIV",
"exemption": "dangerous",
"exemptionComment": "Marked as Exempt.",
"effectiveAnnex": "VIII"
},
"dateSubmitted": "2022-04-13",
"dateIssued": "2022-04-13",
"dateAccepted": "2022-04-13",
"reachDossierType": "AU_IND_CHEM_ASSESS",
"tonnageBand": "BAND3",
"registeredTonnageBand": "BAND_2",
"reason": "INITIAL",
"notes": "string",
"iuclidDossierReference": "string",
"communicationReference": "string",
"submissionNumber": "string",
"status": "SUBMITTED"
}
Schema of the response body
{
"required": [
"registration"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"registration": {
"$ref": "#/components/schemas/RegistrationData"
},
"dateSubmitted": {
"type": "string",
"format": "date"
},
"dateIssued": {
"type": "string",
"format": "date"
},
"dateAccepted": {
"type": "string",
"format": "date"
},
"reachDossierType": {
"type": "string",
"enum": [
"AU_IND_CHEM_ASSESS",
"AU_IND_CHEM_CERT_APPL_T1",
"AU_IND_CHEM_CERT_APPL_T2",
"AU_IND_CHEM_CERT_APPL_T3",
"AU_IND_CHEM_CERT_APPL_T4",
"AU_IND_CHEM_CERT_APPL_T5",
"AU_IND_CHEM_CEA",
"AU_IND_CHEM_PIR",
"BIOC_ACTIVE_SUBSTANCE_FOR_SUBSTANCES",
"BIOC_BASIC_INFORMATION",
"BIOC_BIOCIDAL_PRODUCT",
"BIOC_MICRO",
"BIOC_SUBSTANCE_OF_CONCERN",
"BIOC_SPC",
"BIOC_TECHNICAL_EQUIVALENCE",
"CLP_ALTERNATIVE_NAME",
"CLP_NOTIF",
"CLP_CLH",
"CLP_PCN_ICG",
"CLP_PCN_SFC",
"CLP_PCN",
"R_A15_SVHC",
"R_A15_REST",
"R_AUTH_APPL",
"R_DU_REPORT",
"R_SIA_NOTIF",
"R_1_10_PC",
"R_1_10_STD",
"R_10_100",
"R_100_1000",
"R_ABOVE_1000",
"R_JS_MBER",
"R_INT_JS_MBER",
"R_INT_ONSITE",
"R_INT_ONSITE_1_1000",
"R_INT_ONSITE_ABOVE_1000",
"R_SUB_EVAL",
"R_PPORD",
"R_INQUIRY",
"BIOC_ACTIVE_SUBSTANCE_FOR_MIXTURES",
"R_INT_TR_1_1000",
"R_INT_TR_ABOVE_1000",
"R_DU_NOTIF",
"R_MICROPLASTICS",
"DWD_ARTICLE_11_APPL",
"DWD_NIAS_OR_OTHER_SUBSTANCE",
"DWD_NOTIF",
"FCM_APPL",
"FCM_NIAS",
"EU_PPP_ACTIVE_SUBSTANCE_APP",
"EU_PPP_CA_ACTIVE_SUBSTANCE",
"EU_PPP_BASIC_SUBSTANCE",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS",
"EU_PPP_MICRO",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS_ACTIVE",
"EU_PPP_OTHER_MIXTURE",
"EU_PPP_OTHER_SUBSTANCE_ASSESSED",
"EU_PPP_PESTICIDE_PRODUCT",
"EU_PPP_SAFENERS_SYN_APP",
"EU_TSR_DEROGATION",
"K_REACH_INQUIRY",
"K_REACH_POLYMER_EXEMPTION",
"K_REACH_REAGENT_EXEMPTION",
"K_REACH_RD_EXEMPTION",
"K_REACH_EXPORT_EXEMPTION",
"K_REACH_SURFACE_TREATED_EXEMPTION",
"K_REACH_NON_ISOLATED_INT_EXEMPTION",
"K_REACH_ONSITE_INT_EXEMPTION",
"K_REACH_01_1",
"K_REACH_1_10",
"K_REACH_10_100",
"K_REACH_100_1000",
"K_REACH_ABOVE_1000",
"K_REACH_POLYMER_01_1",
"K_REACH_POLYMER_1_10",
"K_REACH_POLYMER_10_100",
"K_REACH_POLYMER_100_1000",
"K_REACH_POLYMER_ABOVE_1000",
"K_REACH_INT_ONSITE_01_1",
"K_REACH_INT_ONSITE_1_10",
"K_REACH_INT_ONSITE_10_100",
"K_REACH_INT_ONSITE_100_1000",
"K_REACH_INT_ONSITE_ABOVE_1000",
"K_REACH_INT_TR_01_1",
"K_REACH_INT_TR_1_10",
"K_REACH_INT_TR_10_100",
"K_REACH_INT_TR_100_1000",
"K_REACH_INT_TR_ABOVE_1000",
"K_REACH_EXEMPTION_CERT",
"K_REACH_REGISTRATION_CERT",
"K_REACH_HAZARD_EVAL",
"K_REACH_DU_REPORT",
"NZ_HSNO_APPL_FULL_ASSESS_CAT",
"NZ_HSNO_FULL_ASSESS_CAT",
"NZ_HSNO_LMTD_ASSESS_CAT",
"OECD_SIDS",
"OECD_HT_CAT"
]
},
"tonnageBand": {
"type": "string",
"description": "The size of the submitted tonnage band. On input it is ignored when registeredTonnageBand is given (and must then be its size); otherwise it is stored as the registration's current band of that size, or else the legislation's standard band of that size",
"example": "BAND3",
"enum": [
"BAND1",
"BAND2",
"BAND3",
"BAND4",
"BAND5"
]
},
"registeredTonnageBand": {
"type": "string",
"description": "The submitted tonnage band, which must be one of the registration's legislation. Takes precedence over tonnageBand",
"example": "BAND_2",
"enum": [
"BAND_1",
"BAND_2",
"BAND_3",
"BAND_4",
"BAND_5",
"BAND_6",
"BAND_7",
"BAND_8",
"BAND_9",
"BAND_K_1",
"BAND_K_2",
"BAND_K_3",
"BAND_K_4",
"BAND_K_5",
"BAND_K_6",
"BAND_K_7",
"BAND_K_8",
"BAND_K_9",
"BAND_K_10",
"BAND_K_11",
"BAND_K_12",
"BAND_K_13",
"BAND_K_14",
"BAND_K_15",
"BAND_K_16",
"BAND_K_17",
"BAND_K_18",
"BAND_K_19",
"BAND_K_20",
"CEASE_OF_MANUFACTURE"
]
},
"reason": {
"type": "string",
"example": "INITIAL",
"enum": [
"CEASE_OF_MANUFACTURE",
"GRANDFATHERING",
"INITIAL",
"INQUIRY",
"REQUESTED",
"UPDATE_SPONTANEOUS"
]
},
"notes": {
"type": "string"
},
"iuclidDossierReference": {
"type": "string"
},
"communicationReference": {
"type": "string"
},
"submissionNumber": {
"type": "string"
},
"status": {
"type": "string",
"description": "Required, except for a CEASE_OF_MANUFACTURE reason, which never has a status",
"example": "SUBMITTED",
"enum": [
"DRAFT",
"SUBMITTED",
"ACCEPTED",
"REJECTED"
]
}
}
}
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/submissions¶
Get all Submissions
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
constituent |
query | integer | Yes | Filter submissions by constituent | |
page |
query | integer | 0 | Yes | Zero-based page index (0..N) |
size |
query | integer | 20 | Yes | The size of the page to be returned |
sort |
query | array | Yes | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Response 200 OK
{
"totalPages": 55,
"totalElements": 127,
"size": 101,
"content": [
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"registration": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"reachLegislation": "EU_REACH",
"type": "INTERNAL",
"submittingLegalEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"forLegalEntity": null,
"forLegalEntityUuid": "37b58a8c-fae4-485f-bb99-1cf879d34678",
"status": "ACTIVE",
"registrationName": "Calcium dihydroxide",
"registrationNumber": "01-2119475151-45-1000",
"registrationDate": "2022-04-13",
"registrationRole": "MEMBER",
"annex": "VIII",
"publicName": "Calcium dihydroxide",
"reachRole": "MANUFACTURER",
"enquiryNumber": "06-1111111111-11-1111",
"ppordNumber": "04-1111111111-11-1111",
"iuclidUUID": "U37b58a8c-fae4-485f-bb99-1cf666d34678",
"registrationNotes": "Registration is complete.",
"reachDossierType": "A",
"preregistered": true,
"preregistrationName": "Calcium dihydroxide",
"preregistrationNumber": "05-1122334455-66-0001",
"preregistrationDate": "2022-04-13",
"preregistrationNote": "Preregistration complete.",
"exempt": true,
"exemptionType": "ANNEXIV",
"exemption": "dangerous",
"exemptionComment": "Marked as Exempt.",
"effectiveAnnex": "VIII"
},
"dateSubmitted": "2022-04-13",
"dateIssued": "2022-04-13",
"dateAccepted": "2022-04-13",
"reachDossierType": "AU_IND_CHEM_ASSESS",
"tonnageBand": "BAND3",
"registeredTonnageBand": "BAND_2",
"reason": "INITIAL",
"notes": "string",
"iuclidDossierReference": "string",
"communicationReference": "string",
"submissionNumber": "string",
"status": "SUBMITTED"
}
],
"number": 12,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"pageable": {
"offset": 254,
"sort": null,
"unpaged": true,
"paged": true,
"pageSize": 291,
"pageNumber": 242
},
"numberOfElements": 178,
"first": true,
"last": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubmissionData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
POST /api/submissions¶
Create a Submission
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"registration": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"reachLegislation": "EU_REACH",
"type": "INTERNAL",
"submittingLegalEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"forLegalEntity": null,
"forLegalEntityUuid": "37b58a8c-fae4-485f-bb99-1cf879d34678",
"status": "ACTIVE",
"registrationName": "Calcium dihydroxide",
"registrationNumber": "01-2119475151-45-1000",
"registrationDate": "2022-04-13",
"registrationRole": "MEMBER",
"annex": "VIII",
"publicName": "Calcium dihydroxide",
"reachRole": "MANUFACTURER",
"enquiryNumber": "06-1111111111-11-1111",
"ppordNumber": "04-1111111111-11-1111",
"iuclidUUID": "U37b58a8c-fae4-485f-bb99-1cf666d34678",
"registrationNotes": "Registration is complete.",
"reachDossierType": "A",
"preregistered": true,
"preregistrationName": "Calcium dihydroxide",
"preregistrationNumber": "05-1122334455-66-0001",
"preregistrationDate": "2022-04-13",
"preregistrationNote": "Preregistration complete.",
"exempt": true,
"exemptionType": "ANNEXIV",
"exemption": "dangerous",
"exemptionComment": "Marked as Exempt.",
"effectiveAnnex": "VIII"
},
"dateSubmitted": "2022-04-13",
"dateIssued": "2022-04-13",
"dateAccepted": "2022-04-13",
"reachDossierType": "AU_IND_CHEM_ASSESS",
"tonnageBand": "BAND3",
"registeredTonnageBand": "BAND_2",
"reason": "INITIAL",
"notes": "string",
"iuclidDossierReference": "string",
"communicationReference": "string",
"submissionNumber": "string",
"status": "SUBMITTED"
}
Schema of the request body
{
"required": [
"registration"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"registration": {
"$ref": "#/components/schemas/RegistrationData"
},
"dateSubmitted": {
"type": "string",
"format": "date"
},
"dateIssued": {
"type": "string",
"format": "date"
},
"dateAccepted": {
"type": "string",
"format": "date"
},
"reachDossierType": {
"type": "string",
"enum": [
"AU_IND_CHEM_ASSESS",
"AU_IND_CHEM_CERT_APPL_T1",
"AU_IND_CHEM_CERT_APPL_T2",
"AU_IND_CHEM_CERT_APPL_T3",
"AU_IND_CHEM_CERT_APPL_T4",
"AU_IND_CHEM_CERT_APPL_T5",
"AU_IND_CHEM_CEA",
"AU_IND_CHEM_PIR",
"BIOC_ACTIVE_SUBSTANCE_FOR_SUBSTANCES",
"BIOC_BASIC_INFORMATION",
"BIOC_BIOCIDAL_PRODUCT",
"BIOC_MICRO",
"BIOC_SUBSTANCE_OF_CONCERN",
"BIOC_SPC",
"BIOC_TECHNICAL_EQUIVALENCE",
"CLP_ALTERNATIVE_NAME",
"CLP_NOTIF",
"CLP_CLH",
"CLP_PCN_ICG",
"CLP_PCN_SFC",
"CLP_PCN",
"R_A15_SVHC",
"R_A15_REST",
"R_AUTH_APPL",
"R_DU_REPORT",
"R_SIA_NOTIF",
"R_1_10_PC",
"R_1_10_STD",
"R_10_100",
"R_100_1000",
"R_ABOVE_1000",
"R_JS_MBER",
"R_INT_JS_MBER",
"R_INT_ONSITE",
"R_INT_ONSITE_1_1000",
"R_INT_ONSITE_ABOVE_1000",
"R_SUB_EVAL",
"R_PPORD",
"R_INQUIRY",
"BIOC_ACTIVE_SUBSTANCE_FOR_MIXTURES",
"R_INT_TR_1_1000",
"R_INT_TR_ABOVE_1000",
"R_DU_NOTIF",
"R_MICROPLASTICS",
"DWD_ARTICLE_11_APPL",
"DWD_NIAS_OR_OTHER_SUBSTANCE",
"DWD_NOTIF",
"FCM_APPL",
"FCM_NIAS",
"EU_PPP_ACTIVE_SUBSTANCE_APP",
"EU_PPP_CA_ACTIVE_SUBSTANCE",
"EU_PPP_BASIC_SUBSTANCE",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS",
"EU_PPP_MICRO",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS_ACTIVE",
"EU_PPP_OTHER_MIXTURE",
"EU_PPP_OTHER_SUBSTANCE_ASSESSED",
"EU_PPP_PESTICIDE_PRODUCT",
"EU_PPP_SAFENERS_SYN_APP",
"EU_TSR_DEROGATION",
"K_REACH_INQUIRY",
"K_REACH_POLYMER_EXEMPTION",
"K_REACH_REAGENT_EXEMPTION",
"K_REACH_RD_EXEMPTION",
"K_REACH_EXPORT_EXEMPTION",
"K_REACH_SURFACE_TREATED_EXEMPTION",
"K_REACH_NON_ISOLATED_INT_EXEMPTION",
"K_REACH_ONSITE_INT_EXEMPTION",
"K_REACH_01_1",
"K_REACH_1_10",
"K_REACH_10_100",
"K_REACH_100_1000",
"K_REACH_ABOVE_1000",
"K_REACH_POLYMER_01_1",
"K_REACH_POLYMER_1_10",
"K_REACH_POLYMER_10_100",
"K_REACH_POLYMER_100_1000",
"K_REACH_POLYMER_ABOVE_1000",
"K_REACH_INT_ONSITE_01_1",
"K_REACH_INT_ONSITE_1_10",
"K_REACH_INT_ONSITE_10_100",
"K_REACH_INT_ONSITE_100_1000",
"K_REACH_INT_ONSITE_ABOVE_1000",
"K_REACH_INT_TR_01_1",
"K_REACH_INT_TR_1_10",
"K_REACH_INT_TR_10_100",
"K_REACH_INT_TR_100_1000",
"K_REACH_INT_TR_ABOVE_1000",
"K_REACH_EXEMPTION_CERT",
"K_REACH_REGISTRATION_CERT",
"K_REACH_HAZARD_EVAL",
"K_REACH_DU_REPORT",
"NZ_HSNO_APPL_FULL_ASSESS_CAT",
"NZ_HSNO_FULL_ASSESS_CAT",
"NZ_HSNO_LMTD_ASSESS_CAT",
"OECD_SIDS",
"OECD_HT_CAT"
]
},
"tonnageBand": {
"type": "string",
"description": "The size of the submitted tonnage band. On input it is ignored when registeredTonnageBand is given (and must then be its size); otherwise it is stored as the registration's current band of that size, or else the legislation's standard band of that size",
"example": "BAND3",
"enum": [
"BAND1",
"BAND2",
"BAND3",
"BAND4",
"BAND5"
]
},
"registeredTonnageBand": {
"type": "string",
"description": "The submitted tonnage band, which must be one of the registration's legislation. Takes precedence over tonnageBand",
"example": "BAND_2",
"enum": [
"BAND_1",
"BAND_2",
"BAND_3",
"BAND_4",
"BAND_5",
"BAND_6",
"BAND_7",
"BAND_8",
"BAND_9",
"BAND_K_1",
"BAND_K_2",
"BAND_K_3",
"BAND_K_4",
"BAND_K_5",
"BAND_K_6",
"BAND_K_7",
"BAND_K_8",
"BAND_K_9",
"BAND_K_10",
"BAND_K_11",
"BAND_K_12",
"BAND_K_13",
"BAND_K_14",
"BAND_K_15",
"BAND_K_16",
"BAND_K_17",
"BAND_K_18",
"BAND_K_19",
"BAND_K_20",
"CEASE_OF_MANUFACTURE"
]
},
"reason": {
"type": "string",
"example": "INITIAL",
"enum": [
"CEASE_OF_MANUFACTURE",
"GRANDFATHERING",
"INITIAL",
"INQUIRY",
"REQUESTED",
"UPDATE_SPONTANEOUS"
]
},
"notes": {
"type": "string"
},
"iuclidDossierReference": {
"type": "string"
},
"communicationReference": {
"type": "string"
},
"submissionNumber": {
"type": "string"
},
"status": {
"type": "string",
"description": "Required, except for a CEASE_OF_MANUFACTURE reason, which never has a status",
"example": "SUBMITTED",
"enum": [
"DRAFT",
"SUBMITTED",
"ACCEPTED",
"REJECTED"
]
}
}
}
Response 204 No Content
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"registration": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"reachLegislation": "EU_REACH",
"type": "INTERNAL",
"submittingLegalEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"forLegalEntity": null,
"forLegalEntityUuid": "37b58a8c-fae4-485f-bb99-1cf879d34678",
"status": "ACTIVE",
"registrationName": "Calcium dihydroxide",
"registrationNumber": "01-2119475151-45-1000",
"registrationDate": "2022-04-13",
"registrationRole": "MEMBER",
"annex": "VIII",
"publicName": "Calcium dihydroxide",
"reachRole": "MANUFACTURER",
"enquiryNumber": "06-1111111111-11-1111",
"ppordNumber": "04-1111111111-11-1111",
"iuclidUUID": "U37b58a8c-fae4-485f-bb99-1cf666d34678",
"registrationNotes": "Registration is complete.",
"reachDossierType": "A",
"preregistered": true,
"preregistrationName": "Calcium dihydroxide",
"preregistrationNumber": "05-1122334455-66-0001",
"preregistrationDate": "2022-04-13",
"preregistrationNote": "Preregistration complete.",
"exempt": true,
"exemptionType": "ANNEXIV",
"exemption": "dangerous",
"exemptionComment": "Marked as Exempt.",
"effectiveAnnex": "VIII"
},
"dateSubmitted": "2022-04-13",
"dateIssued": "2022-04-13",
"dateAccepted": "2022-04-13",
"reachDossierType": "AU_IND_CHEM_ASSESS",
"tonnageBand": "BAND3",
"registeredTonnageBand": "BAND_2",
"reason": "INITIAL",
"notes": "string",
"iuclidDossierReference": "string",
"communicationReference": "string",
"submissionNumber": "string",
"status": "SUBMITTED"
}
Schema of the response body
{
"required": [
"registration"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"registration": {
"$ref": "#/components/schemas/RegistrationData"
},
"dateSubmitted": {
"type": "string",
"format": "date"
},
"dateIssued": {
"type": "string",
"format": "date"
},
"dateAccepted": {
"type": "string",
"format": "date"
},
"reachDossierType": {
"type": "string",
"enum": [
"AU_IND_CHEM_ASSESS",
"AU_IND_CHEM_CERT_APPL_T1",
"AU_IND_CHEM_CERT_APPL_T2",
"AU_IND_CHEM_CERT_APPL_T3",
"AU_IND_CHEM_CERT_APPL_T4",
"AU_IND_CHEM_CERT_APPL_T5",
"AU_IND_CHEM_CEA",
"AU_IND_CHEM_PIR",
"BIOC_ACTIVE_SUBSTANCE_FOR_SUBSTANCES",
"BIOC_BASIC_INFORMATION",
"BIOC_BIOCIDAL_PRODUCT",
"BIOC_MICRO",
"BIOC_SUBSTANCE_OF_CONCERN",
"BIOC_SPC",
"BIOC_TECHNICAL_EQUIVALENCE",
"CLP_ALTERNATIVE_NAME",
"CLP_NOTIF",
"CLP_CLH",
"CLP_PCN_ICG",
"CLP_PCN_SFC",
"CLP_PCN",
"R_A15_SVHC",
"R_A15_REST",
"R_AUTH_APPL",
"R_DU_REPORT",
"R_SIA_NOTIF",
"R_1_10_PC",
"R_1_10_STD",
"R_10_100",
"R_100_1000",
"R_ABOVE_1000",
"R_JS_MBER",
"R_INT_JS_MBER",
"R_INT_ONSITE",
"R_INT_ONSITE_1_1000",
"R_INT_ONSITE_ABOVE_1000",
"R_SUB_EVAL",
"R_PPORD",
"R_INQUIRY",
"BIOC_ACTIVE_SUBSTANCE_FOR_MIXTURES",
"R_INT_TR_1_1000",
"R_INT_TR_ABOVE_1000",
"R_DU_NOTIF",
"R_MICROPLASTICS",
"DWD_ARTICLE_11_APPL",
"DWD_NIAS_OR_OTHER_SUBSTANCE",
"DWD_NOTIF",
"FCM_APPL",
"FCM_NIAS",
"EU_PPP_ACTIVE_SUBSTANCE_APP",
"EU_PPP_CA_ACTIVE_SUBSTANCE",
"EU_PPP_BASIC_SUBSTANCE",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS",
"EU_PPP_MICRO",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS_ACTIVE",
"EU_PPP_OTHER_MIXTURE",
"EU_PPP_OTHER_SUBSTANCE_ASSESSED",
"EU_PPP_PESTICIDE_PRODUCT",
"EU_PPP_SAFENERS_SYN_APP",
"EU_TSR_DEROGATION",
"K_REACH_INQUIRY",
"K_REACH_POLYMER_EXEMPTION",
"K_REACH_REAGENT_EXEMPTION",
"K_REACH_RD_EXEMPTION",
"K_REACH_EXPORT_EXEMPTION",
"K_REACH_SURFACE_TREATED_EXEMPTION",
"K_REACH_NON_ISOLATED_INT_EXEMPTION",
"K_REACH_ONSITE_INT_EXEMPTION",
"K_REACH_01_1",
"K_REACH_1_10",
"K_REACH_10_100",
"K_REACH_100_1000",
"K_REACH_ABOVE_1000",
"K_REACH_POLYMER_01_1",
"K_REACH_POLYMER_1_10",
"K_REACH_POLYMER_10_100",
"K_REACH_POLYMER_100_1000",
"K_REACH_POLYMER_ABOVE_1000",
"K_REACH_INT_ONSITE_01_1",
"K_REACH_INT_ONSITE_1_10",
"K_REACH_INT_ONSITE_10_100",
"K_REACH_INT_ONSITE_100_1000",
"K_REACH_INT_ONSITE_ABOVE_1000",
"K_REACH_INT_TR_01_1",
"K_REACH_INT_TR_1_10",
"K_REACH_INT_TR_10_100",
"K_REACH_INT_TR_100_1000",
"K_REACH_INT_TR_ABOVE_1000",
"K_REACH_EXEMPTION_CERT",
"K_REACH_REGISTRATION_CERT",
"K_REACH_HAZARD_EVAL",
"K_REACH_DU_REPORT",
"NZ_HSNO_APPL_FULL_ASSESS_CAT",
"NZ_HSNO_FULL_ASSESS_CAT",
"NZ_HSNO_LMTD_ASSESS_CAT",
"OECD_SIDS",
"OECD_HT_CAT"
]
},
"tonnageBand": {
"type": "string",
"description": "The size of the submitted tonnage band. On input it is ignored when registeredTonnageBand is given (and must then be its size); otherwise it is stored as the registration's current band of that size, or else the legislation's standard band of that size",
"example": "BAND3",
"enum": [
"BAND1",
"BAND2",
"BAND3",
"BAND4",
"BAND5"
]
},
"registeredTonnageBand": {
"type": "string",
"description": "The submitted tonnage band, which must be one of the registration's legislation. Takes precedence over tonnageBand",
"example": "BAND_2",
"enum": [
"BAND_1",
"BAND_2",
"BAND_3",
"BAND_4",
"BAND_5",
"BAND_6",
"BAND_7",
"BAND_8",
"BAND_9",
"BAND_K_1",
"BAND_K_2",
"BAND_K_3",
"BAND_K_4",
"BAND_K_5",
"BAND_K_6",
"BAND_K_7",
"BAND_K_8",
"BAND_K_9",
"BAND_K_10",
"BAND_K_11",
"BAND_K_12",
"BAND_K_13",
"BAND_K_14",
"BAND_K_15",
"BAND_K_16",
"BAND_K_17",
"BAND_K_18",
"BAND_K_19",
"BAND_K_20",
"CEASE_OF_MANUFACTURE"
]
},
"reason": {
"type": "string",
"example": "INITIAL",
"enum": [
"CEASE_OF_MANUFACTURE",
"GRANDFATHERING",
"INITIAL",
"INQUIRY",
"REQUESTED",
"UPDATE_SPONTANEOUS"
]
},
"notes": {
"type": "string"
},
"iuclidDossierReference": {
"type": "string"
},
"communicationReference": {
"type": "string"
},
"submissionNumber": {
"type": "string"
},
"status": {
"type": "string",
"description": "Required, except for a CEASE_OF_MANUFACTURE reason, which never has a status",
"example": "SUBMITTED",
"enum": [
"DRAFT",
"SUBMITTED",
"ACCEPTED",
"REJECTED"
]
}
}
}
Response 403 Forbidden
Response 500 Internal Server Error
Study Monitors¶
GET /api/study-monitors/{id}¶
Get a Study Monitor
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"user": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"from": "0019-07-18",
"study": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
}
Schema of the response body
{
"required": [
"from",
"study",
"user"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"user": {
"$ref": "#/components/schemas/UserData"
},
"from": {
"type": "string",
"format": "date",
"example": "0019-07-18"
},
"study": {
"$ref": "#/components/schemas/StudyData"
}
}
}
Response 403 Forbidden
Response 404 Not Found
PUT /api/study-monitors/{id}¶
Fully update a Study Monitor
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"user": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"from": "0019-07-18",
"study": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
}
Schema of the request body
{
"required": [
"from",
"study",
"user"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"user": {
"$ref": "#/components/schemas/UserData"
},
"from": {
"type": "string",
"format": "date",
"example": "0019-07-18"
},
"study": {
"$ref": "#/components/schemas/StudyData"
}
}
}
Response 200 OK
{
"id": 1,
"user": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"from": "0019-07-18",
"study": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
}
Schema of the response body
{
"required": [
"from",
"study",
"user"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"user": {
"$ref": "#/components/schemas/UserData"
},
"from": {
"type": "string",
"format": "date",
"example": "0019-07-18"
},
"study": {
"$ref": "#/components/schemas/StudyData"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
DELETE /api/study-monitors/{id}¶
Delete a Study Monitor
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 204 No Content
Response 403 Forbidden
Response 404 Not Found
PATCH /api/study-monitors/{id}¶
Partially update a Study Monitor
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"user": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"from": "0019-07-18",
"study": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
}
Schema of the request body
{
"required": [
"from",
"study",
"user"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"user": {
"$ref": "#/components/schemas/UserData"
},
"from": {
"type": "string",
"format": "date",
"example": "0019-07-18"
},
"study": {
"$ref": "#/components/schemas/StudyData"
}
}
}
Response 200 OK
{
"id": 1,
"user": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"from": "0019-07-18",
"study": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
}
Schema of the response body
{
"required": [
"from",
"study",
"user"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"user": {
"$ref": "#/components/schemas/UserData"
},
"from": {
"type": "string",
"format": "date",
"example": "0019-07-18"
},
"study": {
"$ref": "#/components/schemas/StudyData"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
GET /api/study-monitors¶
Get all Study Monitors
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
page |
query | integer | 0 | Yes | Zero-based page index (0..N) |
size |
query | integer | 20 | Yes | The size of the page to be returned |
sort |
query | array | Yes | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | |
study |
query | integer | Yes | Get monitors from a specified study |
Response 200 OK
{
"totalPages": 125,
"totalElements": 114,
"size": 160,
"content": [
{
"id": 1,
"user": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"from": "0019-07-18",
"study": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
}
],
"number": 123,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"pageable": {
"offset": 175,
"sort": null,
"unpaged": true,
"paged": true,
"pageSize": 219,
"pageNumber": 70
},
"numberOfElements": 285,
"first": true,
"last": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StudyMonitorData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
POST /api/study-monitors¶
Create a Study Monitor
Request body
{
"id": 1,
"user": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"from": "0019-07-18",
"study": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
}
Schema of the request body
{
"required": [
"from",
"study",
"user"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"user": {
"$ref": "#/components/schemas/UserData"
},
"from": {
"type": "string",
"format": "date",
"example": "0019-07-18"
},
"study": {
"$ref": "#/components/schemas/StudyData"
}
}
}
Response 200 OK
{
"id": 1,
"user": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"from": "0019-07-18",
"study": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
}
Schema of the response body
{
"required": [
"from",
"study",
"user"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"user": {
"$ref": "#/components/schemas/UserData"
},
"from": {
"type": "string",
"format": "date",
"example": "0019-07-18"
},
"study": {
"$ref": "#/components/schemas/StudyData"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Study Managers¶
GET /api/study-managers/{id}¶
Get a Study Manager
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"user": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"from": "0019-07-18",
"study": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
}
Schema of the response body
{
"required": [
"from",
"study",
"user"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"user": {
"$ref": "#/components/schemas/UserData"
},
"from": {
"type": "string",
"format": "date",
"example": "0019-07-18"
},
"study": {
"$ref": "#/components/schemas/StudyData"
}
}
}
Response 403 Forbidden
Response 404 Not Found
PUT /api/study-managers/{id}¶
Fully update a Study Manager
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"user": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"from": "0019-07-18",
"study": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
}
Schema of the request body
{
"required": [
"from",
"study",
"user"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"user": {
"$ref": "#/components/schemas/UserData"
},
"from": {
"type": "string",
"format": "date",
"example": "0019-07-18"
},
"study": {
"$ref": "#/components/schemas/StudyData"
}
}
}
Response 200 OK
{
"id": 1,
"user": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"from": "0019-07-18",
"study": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
}
Schema of the response body
{
"required": [
"from",
"study",
"user"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"user": {
"$ref": "#/components/schemas/UserData"
},
"from": {
"type": "string",
"format": "date",
"example": "0019-07-18"
},
"study": {
"$ref": "#/components/schemas/StudyData"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
DELETE /api/study-managers/{id}¶
Delete a Study Manager
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 204 No Content
Response 403 Forbidden
Response 404 Not Found
PATCH /api/study-managers/{id}¶
Partially update a Study Manager
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"user": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"from": "0019-07-18",
"study": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
}
Schema of the request body
{
"required": [
"from",
"study",
"user"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"user": {
"$ref": "#/components/schemas/UserData"
},
"from": {
"type": "string",
"format": "date",
"example": "0019-07-18"
},
"study": {
"$ref": "#/components/schemas/StudyData"
}
}
}
Response 200 OK
{
"id": 1,
"user": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"from": "0019-07-18",
"study": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
}
Schema of the response body
{
"required": [
"from",
"study",
"user"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"user": {
"$ref": "#/components/schemas/UserData"
},
"from": {
"type": "string",
"format": "date",
"example": "0019-07-18"
},
"study": {
"$ref": "#/components/schemas/StudyData"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
GET /api/study-managers¶
Get all Study Managers
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
page |
query | integer | 0 | Yes | Zero-based page index (0..N) |
size |
query | integer | 20 | Yes | The size of the page to be returned |
sort |
query | array | Yes | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | |
study |
query | integer | Yes | Get managers from a specified study |
Response 200 OK
{
"totalPages": 93,
"totalElements": 43,
"size": 147,
"content": [
{
"id": 1,
"user": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"from": "0019-07-18",
"study": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
}
],
"number": 121,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"pageable": {
"offset": 294,
"sort": null,
"unpaged": true,
"paged": true,
"pageSize": 266,
"pageNumber": 265
},
"numberOfElements": 159,
"first": true,
"last": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StudyManagerData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
POST /api/study-managers¶
Create a Study Manager
Request body
{
"id": 1,
"user": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"from": "0019-07-18",
"study": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
}
Schema of the request body
{
"required": [
"from",
"study",
"user"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"user": {
"$ref": "#/components/schemas/UserData"
},
"from": {
"type": "string",
"format": "date",
"example": "0019-07-18"
},
"study": {
"$ref": "#/components/schemas/StudyData"
}
}
}
Response 200 OK
{
"id": 1,
"user": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"from": "0019-07-18",
"study": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
}
Schema of the response body
{
"required": [
"from",
"study",
"user"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"user": {
"$ref": "#/components/schemas/UserData"
},
"from": {
"type": "string",
"format": "date",
"example": "0019-07-18"
},
"study": {
"$ref": "#/components/schemas/StudyData"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Study Groups¶
PUT /api/study-groups/{id}¶
Update a Study Group
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Category 5 Analytical Testing",
"description": "This group is for all analytical studies within category 5"
}
Schema of the request body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Category 5 Analytical Testing"
},
"description": {
"type": "string",
"example": "This group is for all analytical studies within category 5"
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Category 5 Analytical Testing",
"description": "This group is for all analytical studies within category 5"
}
Schema of the response body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Category 5 Analytical Testing"
},
"description": {
"type": "string",
"example": "This group is for all analytical studies within category 5"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/study-groups/{id}¶
Delete a Study Group
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/study-groups/{id}¶
Partially Update a Study Group
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Category 5 Analytical Testing",
"description": "This group is for all analytical studies within category 5"
}
Schema of the request body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Category 5 Analytical Testing"
},
"description": {
"type": "string",
"example": "This group is for all analytical studies within category 5"
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Category 5 Analytical Testing",
"description": "This group is for all analytical studies within category 5"
}
Schema of the response body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Category 5 Analytical Testing"
},
"description": {
"type": "string",
"example": "This group is for all analytical studies within category 5"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/study-groups¶
Get Study Groups
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
page |
query | integer | 0 | Yes | Zero-based page index (0..N) |
size |
query | integer | 20 | Yes | The size of the page to be returned |
sort |
query | array | Yes | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | |
study |
query | integer | Yes | Filter Study Groups by Study |
Response 200 OK
{
"totalPages": 157,
"totalElements": 237,
"size": 248,
"content": [
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Category 5 Analytical Testing",
"description": "This group is for all analytical studies within category 5"
}
],
"number": 3,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"pageable": {
"offset": 63,
"sort": null,
"unpaged": true,
"paged": true,
"pageSize": 12,
"pageNumber": 142
},
"numberOfElements": 110,
"first": true,
"last": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StudyGroupData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
{
"totalPages": 287,
"totalElements": 247,
"size": 238,
"content": [
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Category 5 Analytical Testing",
"description": "This group is for all analytical studies within category 5"
}
],
"number": 58,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"pageable": {
"offset": 114,
"sort": null,
"unpaged": true,
"paged": true,
"pageSize": 30,
"pageNumber": 271
},
"numberOfElements": 178,
"first": true,
"last": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StudyGroupData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
POST /api/study-groups¶
Create a Study Group
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Category 5 Analytical Testing",
"description": "This group is for all analytical studies within category 5"
}
Schema of the request body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Category 5 Analytical Testing"
},
"description": {
"type": "string",
"example": "This group is for all analytical studies within category 5"
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Category 5 Analytical Testing",
"description": "This group is for all analytical studies within category 5"
}
Schema of the response body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Category 5 Analytical Testing"
},
"description": {
"type": "string",
"example": "This group is for all analytical studies within category 5"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/study-groups/{groupId}/studies/{studyId}¶
Link a Study to Study Group
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
groupId |
path | integer | No | ||
studyId |
path | integer | No |
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Category 5 Analytical Testing",
"description": "This group is for all analytical studies within category 5"
}
Schema of the response body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Category 5 Analytical Testing"
},
"description": {
"type": "string",
"example": "This group is for all analytical studies within category 5"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/study-groups/{groupId}/studies/{studyId}¶
Unlink a Study from Study Group
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
groupId |
path | integer | No | ||
studyId |
path | integer | No |
Response 200 OK
Response 400 Bad Request
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/study-groups/{groupId}¶
Get A Study Group
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
groupId |
path | integer | No |
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Category 5 Analytical Testing",
"description": "This group is for all analytical studies within category 5"
}
Schema of the response body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Category 5 Analytical Testing"
},
"description": {
"type": "string",
"example": "This group is for all analytical studies within category 5"
}
}
}
Response 403 Forbidden
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Category 5 Analytical Testing",
"description": "This group is for all analytical studies within category 5"
}
Schema of the response body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Category 5 Analytical Testing"
},
"description": {
"type": "string",
"example": "This group is for all analytical studies within category 5"
}
}
}
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,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
Schema of the response body
{
"required": [
"end",
"name",
"partitionId",
"start",
"status"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "001-Cat Z-Analysis-Int"
},
"status": {
"type": "string",
"example": "ACTIVE",
"enum": [
"PLANNED",
"CONTRACTING",
"ACTIVE",
"COMPLETE",
"CANCELLED",
"FINAL_REPORTED"
]
},
"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",
"CHINA",
"COLOMBIA_REACH",
"EU_BIO",
"EU_PLANT",
"US_TSCA",
"PROD_SAFETY",
"INV_WORK"
]
},
"archived": {
"type": "boolean"
},
"testingLaboratoryEntity": {
"$ref": "#/components/schemas/EntityData"
}
}
}
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
PUT /api/studies/{id}¶
Fully Update a Study
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
Schema of the request body
{
"required": [
"end",
"name",
"partitionId",
"start",
"status"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "001-Cat Z-Analysis-Int"
},
"status": {
"type": "string",
"example": "ACTIVE",
"enum": [
"PLANNED",
"CONTRACTING",
"ACTIVE",
"COMPLETE",
"CANCELLED",
"FINAL_REPORTED"
]
},
"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",
"CHINA",
"COLOMBIA_REACH",
"EU_BIO",
"EU_PLANT",
"US_TSCA",
"PROD_SAFETY",
"INV_WORK"
]
},
"archived": {
"type": "boolean"
},
"testingLaboratoryEntity": {
"$ref": "#/components/schemas/EntityData"
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
Schema of the response body
{
"required": [
"end",
"name",
"partitionId",
"start",
"status"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "001-Cat Z-Analysis-Int"
},
"status": {
"type": "string",
"example": "ACTIVE",
"enum": [
"PLANNED",
"CONTRACTING",
"ACTIVE",
"COMPLETE",
"CANCELLED",
"FINAL_REPORTED"
]
},
"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",
"CHINA",
"COLOMBIA_REACH",
"EU_BIO",
"EU_PLANT",
"US_TSCA",
"PROD_SAFETY",
"INV_WORK"
]
},
"archived": {
"type": "boolean"
},
"testingLaboratoryEntity": {
"$ref": "#/components/schemas/EntityData"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
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,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
Schema of the request body
{
"required": [
"end",
"name",
"partitionId",
"start",
"status"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "001-Cat Z-Analysis-Int"
},
"status": {
"type": "string",
"example": "ACTIVE",
"enum": [
"PLANNED",
"CONTRACTING",
"ACTIVE",
"COMPLETE",
"CANCELLED",
"FINAL_REPORTED"
]
},
"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",
"CHINA",
"COLOMBIA_REACH",
"EU_BIO",
"EU_PLANT",
"US_TSCA",
"PROD_SAFETY",
"INV_WORK"
]
},
"archived": {
"type": "boolean"
},
"testingLaboratoryEntity": {
"$ref": "#/components/schemas/EntityData"
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
Schema of the response body
{
"required": [
"end",
"name",
"partitionId",
"start",
"status"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "001-Cat Z-Analysis-Int"
},
"status": {
"type": "string",
"example": "ACTIVE",
"enum": [
"PLANNED",
"CONTRACTING",
"ACTIVE",
"COMPLETE",
"CANCELLED",
"FINAL_REPORTED"
]
},
"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",
"CHINA",
"COLOMBIA_REACH",
"EU_BIO",
"EU_PLANT",
"US_TSCA",
"PROD_SAFETY",
"INV_WORK"
]
},
"archived": {
"type": "boolean"
},
"testingLaboratoryEntity": {
"$ref": "#/components/schemas/EntityData"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
GET /api/studies¶
Get all Studies
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
group |
query | integer | Yes | Filter studies by study group | |
page |
query | integer | 0 | Yes | Zero-based page index (0..N) |
size |
query | integer | 20 | Yes | The size of the page to be returned |
sort |
query | array | Yes | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Response 200 OK
{
"totalPages": 50,
"totalElements": 48,
"size": 159,
"content": [
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
],
"number": 271,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"pageable": {
"offset": 95,
"sort": null,
"unpaged": true,
"paged": true,
"pageSize": 291,
"pageNumber": 203
},
"numberOfElements": 195,
"first": true,
"last": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StudyData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
POST /api/studies¶
Create a Study
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
Schema of the request body
{
"required": [
"end",
"name",
"partitionId",
"start",
"status"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "001-Cat Z-Analysis-Int"
},
"status": {
"type": "string",
"example": "ACTIVE",
"enum": [
"PLANNED",
"CONTRACTING",
"ACTIVE",
"COMPLETE",
"CANCELLED",
"FINAL_REPORTED"
]
},
"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",
"CHINA",
"COLOMBIA_REACH",
"EU_BIO",
"EU_PLANT",
"US_TSCA",
"PROD_SAFETY",
"INV_WORK"
]
},
"archived": {
"type": "boolean"
},
"testingLaboratoryEntity": {
"$ref": "#/components/schemas/EntityData"
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
Schema of the response body
{
"required": [
"end",
"name",
"partitionId",
"start",
"status"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "001-Cat Z-Analysis-Int"
},
"status": {
"type": "string",
"example": "ACTIVE",
"enum": [
"PLANNED",
"CONTRACTING",
"ACTIVE",
"COMPLETE",
"CANCELLED",
"FINAL_REPORTED"
]
},
"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",
"CHINA",
"COLOMBIA_REACH",
"EU_BIO",
"EU_PLANT",
"US_TSCA",
"PROD_SAFETY",
"INV_WORK"
]
},
"archived": {
"type": "boolean"
},
"testingLaboratoryEntity": {
"$ref": "#/components/schemas/EntityData"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/studies/{studyId}/constituents/{constituentId}¶
Link Constituent to Study
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
constituentId |
path | integer | No | ||
studyId |
path | integer | No |
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
}
Schema of the response body
{
"required": [
"end",
"name",
"partitionId",
"start",
"status"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "001-Cat Z-Analysis-Int"
},
"status": {
"type": "string",
"example": "ACTIVE",
"enum": [
"PLANNED",
"CONTRACTING",
"ACTIVE",
"COMPLETE",
"CANCELLED",
"FINAL_REPORTED"
]
},
"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",
"CHINA",
"COLOMBIA_REACH",
"EU_BIO",
"EU_PLANT",
"US_TSCA",
"PROD_SAFETY",
"INV_WORK"
]
},
"archived": {
"type": "boolean"
},
"testingLaboratoryEntity": {
"$ref": "#/components/schemas/EntityData"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/studies/{studyId}/constituents/{constituentId}¶
Unlink Constituent to Study
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
constituentId |
path | integer | No | ||
studyId |
path | integer | No |
Response 200 OK
Response 400 Bad Request
Response 403 Forbidden
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
[
{
"records": [
{
"currency": "string",
"currencyInstance": {
"currencyCode": "string",
"numericCodeAsString": "string",
"displayName": "string",
"symbol": "string",
"defaultFractionDigits": 99,
"numericCode": 264
},
"constituents": [
{
"id": 196,
"casNumber": "string",
"ecName": "string",
"ecNumber": "string",
"ecDescription": "string",
"iupac": "string",
"iuclidUuid": "string",
"tsca": "string",
"molecularFormula": "string",
"smiles": "string",
"inChl": "string",
"name": "string",
"partitionId": 157,
"type": "string",
"archived": true
}
],
"categoryGroups": [
{
"groupName": "string",
"partitionId": 84
}
],
"products": [
{
"id": 185,
"name": "string",
"ownerManufacturer": "string",
"partitionId": 91,
"archived": true
}
],
"externalRef": "string",
"constituentsFallback": null,
"additionalShare": 115,
"budgetType": "COST_ALL",
"costsShared": true,
"additionalShareDecimal": 10.12,
"name": "string",
"id": {},
"url": "string",
"partitionId": 298,
"partition": {
"id": 93,
"partitionName": "string",
"logoID": "9377aef8-f24c-41fb-be59-f6b22d1887f3",
"email": "string",
"userPartitions": [
{
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 175,
"user": {
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 133,
"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,
"lockedTime": "2022-04-13T15:42:05.901Z",
"failedLoginCount": 54,
"notActiveAfter": "2022-04-13",
"passwordExpires": "2022-04-13",
"deleted": true,
"externalId": "string",
"scimManaged": true,
"version": 49,
"owner": {
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 47,
"name": "string",
"version": 130,
"companyNo": "string",
"vatNo": "string",
"remarks": "string",
"dunnNo": "string",
"utr": "string",
"uclidID": "string",
"reachID": "string",
"clientPartitionId": 281,
"poNumber": "string",
"sapBusinessReference": "string",
"invoicingReference": "string",
"consortiumMember": true,
"hasInvoicingAddress": true,
"deleted": true,
"invoiceOverdueDays": 230,
"groups": [
{
"name": "string",
"partitionId": 230
}
],
"primaryInvoicingContact": {
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 142,
"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,
"deactivated": true,
"deleted": true,
"productEntityContacts": [
{
"id": 20,
"productEntity": {
"id": 121,
"product": null,
"baseEntity": null,
"entityRoles": [
{
"id": "string",
"display": "string",
"appliesTo": "CONSTITUENT",
"categories": [
"SUPPLY_CHAIN"
],
"groupMembership": "MEMBER",
"name": "string",
"protected": true,
"linkRole": true,
"url": "string",
"partitionId": 269,
"partition": null,
"idInPartition": 138,
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": {
"name": "string",
"id": {},
"url": "string",
"partitionId": 76,
"partition": null,
"idInPartition": 19,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
},
"iconClass": "string",
"iconColour": "string"
}
],
"deleted": true,
"partitionId": 82
},
"contact": null,
"deleted": true
}
],
"productPartyContacts": [
{
"id": 131,
"productParty": {
"id": 24,
"product": null,
"party": {
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 38,
"entity": null,
"description": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"townCity": "string",
"countyStateRegion": "string",
"postcode": "string",
"country": {
"id": 276,
"name": "string",
"iso3166alpha2CountryCode": "string",
"iso3166alpha3CountryCode": "string",
"iso3166numeric3CountryCode": "string",
"partitionId": 134
},
"website": "string",
"telephone": "string",
"fax": "string",
"remarks": "string",
"addressType": "PRIMARY_ADDRESS",
"sapBusinessReference": "string",
"deleted": true,
"contacts": null,
"plants": [
{
"id": 120,
"party": null,
"name": "string",
"plantCode": "string",
"constituentPlants": [
{
"id": 128,
"constituent": null,
"plant": null
}
],
"productPlants": [
{
"id": 180,
"product": null,
"plant": null
}
]
}
],
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"partitionId": 88
},
"start": "2022-04-13",
"end": "2022-04-13",
"deleted": true
},
"contact": null,
"deleted": true
}
],
"productContacts": [
{
"id": 212,
"product": null,
"contact": null,
"contactType": "KEY",
"deleted": true
}
],
"constituentEntityContacts": [
{
"id": 72,
"constituentEntity": {
"id": 68,
"constituent": null,
"entity": null,
"entityRoles": null,
"partitionId": 293
},
"contact": null,
"deleted": true
}
],
"constituentPartyContacts": [
{
"id": 177,
"constituentParty": {
"id": 278,
"constituent": null,
"party": null,
"start": "2022-04-13",
"end": "2022-04-13",
"deleted": true
},
"contact": null,
"deleted": true
}
],
"constituentContacts": [
{
"id": 55,
"constituent": null,
"contact": null,
"contactType": "KEY",
"deleted": true
}
],
"contactGroups": [
{
"id": 38,
"contact": null,
"contactGroup": {
"groupName": "string",
"partitionId": 38
},
"role": "GROUP_MEMBER",
"deleted": true
}
],
"primaryInvoicingEntities": null,
"secondaryInvoicingEntities": null,
"tonnageAndUseEnquiries": [
{
"reachLegislation": "AUSTRALIA_AICIS",
"contact": null,
"baseEntity": null,
"enquiryYear": 282,
"documentLink": {
"id": 236,
"contact": null,
"code": "string",
"created": "2022-04-13",
"documentLinkAttachments": [
{
"id": 13,
"document": {
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 234,
"partition": null,
"title": "string",
"description": "string",
"fileName": "string",
"originalFileName": "string",
"link": true,
"fileSize": 46,
"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,
"products": null,
"constituents": null,
"categoryGroups": null,
"productGroups": [
{
"groupName": "string",
"partitionId": 140
}
],
"entities": null,
"entityGroups": null,
"contactGroups": null,
"documentTagSet": [
{
"id": 38,
"document": null,
"tag": {
"id": {
"partitionId": 223,
"id": 292
},
"tagText": "string"
},
"deleted": true
}
],
"linkedDocuments": null,
"version": 55,
"versionIdentifier": "string",
"currentDocumentId": 262,
"currentDocument": null,
"versions": null,
"newsItem": true,
"sourceEmail": [
{
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 186,
"partition": null,
"title": "string",
"description": "string",
"fileName": "string",
"originalFileName": "string",
"link": true,
"fileSize": 116,
"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,
"products": null,
"constituents": null,
"categoryGroups": null,
"productGroups": null,
"entities": null,
"entityGroups": null,
"contactGroups": null,
"version": 95,
"versionIdentifier": "string",
"currentDocumentId": 267,
"currentDocument": null,
"newsItem": true,
"internalSourceEmails": [
{
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 82,
"partition": null,
"title": "string",
"description": "string",
"fileName": "string",
"originalFileName": "string",
"link": true,
"fileSize": 92,
"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,
"products": null,
"constituents": null,
"categoryGroups": null,
"productGroups": null,
"entities": null,
"entityGroups": null,
"contactGroups": null,
"version": 112,
"versionIdentifier": "string",
"currentDocumentId": 245,
"currentDocument": null,
"newsItem": true,
"issues": [
{
"id": 83,
"clientPartition": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdated": "2022-04-13T15:42:05.901Z",
"version": 298,
"issue": "string",
"statement": "string",
"basis": "string",
"reviewDate": "2022-04-13",
"reviewNotified": true,
"supportingDocuments": null,
"products": null,
"constituents": null,
"studies": [
{
"id": 208,
"code": "string",
"status": "PLANNED",
"species": [
{
"id": 195,
"description": "string"
}
],
"purpose": "VI",
"start": "2022-04-13",
"end": "2022-04-13",
"folder": {
"id": 22,
"partitionId": 296,
"name": "string",
"parent": null,
"children": null,
"documents": null,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"deletable": true,
"study": null,
"folderPath": "string",
"folderLinks": "string"
},
"partitionId": 162
}
],
"entities": null,
"notes": "string",
"inventoryId": "916a39ad-f929-40c3-bbe2-7ffaf2dec240",
"comments": [
{
"id": 15,
"replyTo": {
"id": 281,
"replyTo": null,
"createdDate": "2022-04-13T15:42:05.901Z",
"user": null,
"contact": null,
"text": "string",
"published": true,
"ragStatus": "RED",
"hidden": true,
"reply": true,
"serverCreatedReadableDate": "string",
"replyToIsUnpublished": true,
"createdBy": null,
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedById": 91,
"name": "string",
"partition": null,
"idInPartition": 21,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"allDay": true,
"calendarSource": "PRODUCT",
"calendarEnd": "2022-04-13T15:42:05.901Z",
"calendarExtendedProps": {}
},
"createdDate": "2022-04-13T15:42:05.901Z",
"user": null,
"contact": null,
"text": "string",
"published": true,
"replies": null,
"ragStatus": "RED",
"hidden": true,
"reply": true,
"serverCreatedReadableDate": "string",
"replyToIsUnpublished": true,
"createdBy": null,
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedById": 20,
"name": "string",
"partition": null,
"idInPartition": 254,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"allDay": true,
"calendarSource": "PRODUCT",
"calendarEnd": "2022-04-13T15:42:05.901Z",
"calendarExtendedProps": {}
}
],
"watchingUsers": null,
"relevantEntities": null,
"tasks": [
{
"id": 209,
"clientPartition": null,
"campaign": {
"id": 12,
"name": "Calcium dihydroxide JSG",
"partitionId": 101,
"description": "Joint submission group portal for calcium dihydroxide",
"startDate": "2025-01-01",
"endDate": "2030-12-31",
"archived": false
},
"contact": null,
"role": {
"id": 155,
"clientPartition": null,
"name": "string",
"description": "string",
"campaign": null,
"campaignContacts": [
{
"id": 225,
"clientPartition": null,
"campaign": null,
"contact": null,
"roles": null,
"lastLoggedIn": "2022-04-13T15:42:05.901Z",
"deleted": true,
"fullName": "string",
"user": null,
"email": "string",
"lastName": "string",
"firstName": "string",
"userCreated": true,
"fullNameFallback": "string",
"recordName": "string",
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"name": "string",
"url": "string",
"partitionId": 204,
"partition": null,
"idInPartition": 183,
"display": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
]
}
],
"pages": [
{
"id": 248,
"clientPartition": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdated": "2022-04-13T15:42:05.901Z",
"name": "string",
"index": 295,
"content": "string",
"caretPosition": "string",
"type": "BUDGETS",
"roles": null,
"access": "ASSOCIATED",
"deleted": true,
"visibleToDeactivated": true,
"source": "ENTITY",
"constituent": null,
"categoryGroup": null,
"entity": null,
"entityGroup": null,
"contactGroup": null,
"contactGroupRole": "GROUP_MEMBER",
"legislations": [
"AUSTRALIA_AICIS"
],
"registrationRoles": [
"LEAD"
],
"annexes": [
"IV"
],
"entityRoles": null,
"cutOffDate": "2022-04-13",
"hideDownloadedColumn": true,
"config": {
"showing": "ACTUAL",
"purchaseNumber": "string",
"otherEntity": null,
"address": "string",
"invoicePageFooter": "string",
"vat": "string",
"invoicingContacts": "string"
},
"docType": "DOCUMENT",
"tags": null,
"task": null,
"notifications": [
{
"id": 240,
"partitionId": 176,
"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": {
"templateName": "string",
"subject": "string",
"globalTemplateVars": {},
"recipients": [
{
"email": "string",
"templateVars": {}
}
],
"attachments": [
{
"type": "string",
"filename": "string",
"data": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
}
],
"priority": "LOW_FIFO"
},
"createdInstant": "2022-04-13T15:42:05.901Z",
"name": "string",
"partition": null,
"idInPartition": 100,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"visible": true,
"public": true,
"entities": null,
"url": "string",
"archived": true,
"openToSignedIn": true,
"activeEntities": null,
"issues": [
{
"uuid": "d1dcdf4e-8dc3-493f-bb7c-fdee340f156f",
"error": "string",
"html": "string"
}
],
"ancestorsString": "string",
"sections": [
{
"id": 241,
"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,
"forNewUi": true,
"deleted": true,
"pages": null,
"menuIndex": 160,
"url": "string",
"display": "string",
"ancestorsString": "string",
"descendants": null,
"campaignNavigationLevel": 260,
"allPages": null,
"menuParent": {
"campaignNavigationLevel": 56,
"expand": true,
"menuIndex": 233,
"menuParent": null,
"menuAncestors": null,
"name": "string",
"id": {},
"url": "string",
"partitionId": 284,
"partition": null,
"idInPartition": 183,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
},
"recordName": "string",
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"updateOptions": {
"campaignId": 221,
"updateRole": true,
"defaultRoleId": 238,
"createCampaigns": true,
"createContacts": true,
"forCampaign": true
},
"menuAncestors": null,
"partitionId": 137,
"partition": null,
"idInPartition": 194,
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"lastUpdatedById": 24
}
],
"nameWithSections": "string",
"campaignNavigationLevel": 135,
"contactInformation": null,
"menuIndex": 98,
"constituentFallback": null,
"menuParent": null,
"highestSection": null,
"iconClass": "string",
"allFields": "string",
"associatedToArchivedContact": true,
"membersUrl": "string",
"membersUrlNewUi": "string",
"accessibleToDisplay": "string",
"expand": true,
"menuAncestors": null,
"partitionId": 108,
"partition": null,
"idInPartition": 147,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"iconColour": "string",
"hidden": true,
"allUsers": true,
"restrictedToConstituent": true,
"restrictedToCompanies": true,
"restrictedToContactGroup": true,
"associationRestricted": true,
"restrictedToAssociations": true,
"associatedAccessDisplay": "string",
"relationshipCriteriaDisplay": "string",
"contactGroupRestrictionDisplay": "string",
"association": "CONSTITUENT",
"associatedRecord": null,
"lastUpdatedById": 71
}
],
"tasks": null,
"contactCount": 283,
"tabCount": 245,
"taskCount": 202,
"inUse": true,
"legislations": [
"AUSTRALIA_AICIS"
],
"registrationRoles": [
"LEAD"
],
"annexes": [
"IV"
],
"entityRoles": null,
"contactGroupRole": "GROUP_MEMBER",
"constituent": null,
"entity": null,
"entityGroup": null,
"deactivated": true,
"member": true,
"sanctioned": true,
"breadcrumbParent": null,
"iconClass": "string",
"assigned": true,
"url": "string",
"partitionId": 243,
"partition": null,
"idInPartition": 260,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"iconColour": "string"
},
"access": "ASSOCIATED",
"template": {
"id": 206,
"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": 68,
"template": null,
"type": "BOOLEAN",
"index": 204,
"required": true,
"range": true,
"rangeMinimum": 10.12,
"rangeMaximum": 10.12,
"question": "string",
"defaultValue": "string",
"color": "string",
"options": [
{
"id": 211,
"template": null,
"option": "string"
}
]
}
],
"iconClass": "string",
"lastUpdatedById": 89,
"url": "string",
"partitionId": 96,
"partition": null,
"idInPartition": 112,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"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,
"constituent": null,
"categoryGroup": null,
"entity": null,
"entityGroup": null,
"contactGroup": null,
"contactGroupRole": "GROUP_MEMBER",
"legislations": [
"AUSTRALIA_AICIS"
],
"registrationRoles": [
"LEAD"
],
"annexes": [
"IV"
],
"entityRoles": null,
"surveyFields": [
{
"id": 264,
"fieldType": "BOOLEAN",
"name": "string",
"defaultValue": "string",
"selectOptionValues": [
{
"id": 246,
"surveyField": null,
"value": "string",
"index": 88
}
],
"index": 247,
"required": true,
"range": true,
"color": "string",
"rangeMinimum": 10.12,
"rangeMaximum": 10.12,
"campaignContactTask": null,
"nameAsText": "string",
"nameIssues": null,
"nameContainsHtml": true,
"selectValuesArray": [
"string"
],
"namePreview": "string"
}
],
"surveyRoles": [
"MANUFACTURER"
],
"uses": [
"39cc9e9e-65e9-4bc0-9739-c6226c63a0a5"
],
"user": null,
"createdDate": "2022-04-13T15:42:05.901Z",
"uploadNotificationEmail": "string",
"pages": null,
"taskGroupLinks": [
{
"id": {
"taskGroupId": 80,
"taskId": 22
},
"taskGroup": {
"id": 77,
"clientPartition": null,
"name": "string",
"description": "string",
"campaign": null,
"taskLinks": null,
"pages": [
{
"id": 140,
"taskGroup": null,
"page": null,
"cutOffDate": "2022-04-13",
"index": 206
}
],
"url": "string",
"breadcrumbParent": null,
"iconClass": "string",
"descriptionContainsHtml": true,
"partitionId": 186,
"partition": null,
"idInPartition": 106,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"iconColour": "string"
},
"task": null,
"index": 0
}
],
"deleted": true,
"watchingUsers": null,
"comments": [
{
"id": 283,
"replyTo": null,
"createdDate": "2022-04-13T15:42:05.901Z",
"user": null,
"contact": null,
"text": "string",
"published": true,
"replies": null,
"ragStatus": "RED",
"calendarSource": "PRODUCT",
"hidden": true,
"reply": true,
"serverCreatedReadableDate": "string",
"replyToIsUnpublished": true,
"createdBy": null,
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedById": 14,
"name": "string",
"partition": null,
"idInPartition": 183,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"allDay": true,
"calendarEnd": "2022-04-13T15:42:05.901Z",
"calendarExtendedProps": {}
}
],
"events": [
{
"id": 204,
"clientPartition": null,
"task": null,
"contact": null,
"eventDate": "2022-04-13T15:42:05.901Z",
"completed": true,
"surveyValues": [
{
"id": 28,
"surveyField": null,
"value": "string",
"deleted": true,
"campaignContactEvent": null,
"fieldType": "BOOLEAN",
"file": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=",
"fileName": "string",
"valueAsUUID": "109efa8c-38dd-4998-9514-dec1d13e36ed",
"valueAsDate": "2022-04-13",
"valueSanitized": "string"
}
],
"documentDates": [
{
"id": 106,
"document": null,
"dateAccessed": "2022-04-13T15:42:05.901Z",
"events": null
}
],
"useSurvey": {
"id": 250,
"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": "MANUFACTURER",
"date": "2022-04-13",
"constituent": null,
"status": "ACTIVE",
"validTonnageFromLastYear": true,
"importedTonnage": 10.12,
"exportedTonnage": 10.12,
"orTonnage": 10.12,
"polymerImportedTonnage": 10.12,
"residualMonomerConcentration": 10.12,
"useTonnages": [
{
"id": 92,
"useSurvey": null,
"use": "6c548b45-910a-437f-a0ba-d213983ad7b9",
"useNameFallback": "string",
"useLifeCycleFallback": "string",
"tonnage": 10.12,
"maxSiteTonnage": 10.12,
"notes": "string",
"exposureMonitored": true,
"proceduresDocumented": true,
"itselfUsedAsFuel": true,
"intentionallyBlendedIntoFuel": true,
"monitoringDataForTreatmentProvided": true,
"monitoringDataForTreatmentDetails": "string",
"proportionOfSubstanceEmittedProvided": true,
"proportionOfSubstanceEmittedDetails": "string",
"environmentalQuestionsFile": "93472d7f-3d90-4d08-919e-2799afd52848",
"legalEmissions": true,
"functions": [
{
"id": 232,
"useSurveyTonnage": null,
"functionId": 247,
"functionNameFallback": "string"
}
],
"tonnageDetails": [
{
"id": 218,
"useSurveyTonnage": null,
"productCategory": "string",
"processCategory": 72,
"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": [
"54b160a1-2924-415a-9086-475699b53dbb"
],
"sdsFileNames": [
"string"
],
"environmentalQuestionsFileName": "string"
}
],
"notes": "string",
"additionalUsesNotes": "string",
"additionalUsesFile": "547c01f3-91b9-4323-99eb-352422f158b6",
"empty": true,
"entities": null,
"additionalUsesFileName": "string",
"ceasedManufacture": true,
"onlyRepresentative": true,
"lastUpdatedById": 59,
"name": "string",
"url": "string",
"partitionId": 80,
"partition": null,
"idInPartition": 174,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
},
"fileId": "3ae9d9ea-c11a-4a76-8ff4-e3ada8250967",
"fileName": "string",
"url": "string",
"display": "string",
"campaign": null,
"responses": [
{
"id": 189,
"surveyField": null,
"value": "string",
"deleted": true,
"fieldType": "BOOLEAN",
"file": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=",
"fileName": "string",
"valueAsUUID": "4c781af9-f147-4404-b079-3390bcdd268c",
"valueAsDate": "2022-04-13",
"valueSanitized": "string"
}
],
"calendarStart": "2022-04-13T15:42:05.901Z",
"downloadedDocuments": null,
"deleted": true,
"responsesDeleted": true,
"downloadedDocumentIds": [
170
],
"downloadedOldDocumentsOf": [
134
],
"allDay": true,
"calendarSource": "PRODUCT",
"calendarEnd": "2022-04-13T15:42:05.901Z",
"calendarDisplay": "string",
"calendarExtendedProps": {},
"name": "string",
"partitionId": 276,
"partition": null,
"idInPartition": 71,
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"uploadNotifications": [
{
"id": 287,
"partitionId": 17,
"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,
"createdInstant": "2022-04-13T15:42:05.901Z",
"name": "string",
"partition": null,
"idInPartition": 7,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"surveyNotifications": [
{
"id": 280,
"partitionId": 52,
"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,
"createdInstant": "2022-04-13T15:42:05.901Z",
"name": "string",
"partition": null,
"idInPartition": 86,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"iuclidReviewNotifications": [
{
"id": 79,
"partitionId": 97,
"created": "2022-04-13T15:42:05.901Z",
"user": null,
"read": true,
"campaignContactTask": null,
"contact": null,
"baseUrl": "string",
"approval": true,
"url": "string",
"mailjetTemplateName": "string",
"displayCode": "string",
"mailjetTemplateVars": {},
"mailjetTemplateEmail": null,
"createdInstant": "2022-04-13T15:42:05.901Z",
"name": "string",
"partition": null,
"idInPartition": 55,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"sendCustomSurveyNotificationEmail": true,
"showDocumentNameOnDownloads": true,
"allowDownload": true,
"public": true,
"closed": true,
"commentType": "string",
"groups": null,
"url": "string",
"archived": true,
"openToSignedIn": true,
"forYear": 225,
"activeDownload": null,
"containingArchivedDocument": true,
"createdLocalDate": "2022-04-13",
"letterOfAccessRelated": true,
"instructionsIssues": null,
"endingInstructionsIssues": null,
"recordName": "string",
"breadcrumbParent": null,
"iconClass": "string",
"webPortalDisplay": "string",
"campaignIfUnrestricted": null,
"associatedContacts": null,
"activeIuclidDownload": {
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 224,
"partition": null,
"title": "string",
"description": "string",
"fileName": "string",
"originalFileName": "string",
"link": true,
"fileSize": 195,
"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,
"products": null,
"constituents": null,
"categoryGroups": null,
"productGroups": null,
"entities": null,
"entityGroups": null,
"contactGroups": null,
"version": 116,
"versionIdentifier": "string",
"currentDocumentId": 84,
"currentDocument": null,
"newsItem": true,
"deleted": true,
"deletedDate": "2022-04-13T15:42:05.901Z",
"fileId": "0d080751-a290-40a9-b2c0-2b54df810e9e",
"watchingUsers": null,
"retentionNotifications": [
{
"id": 149,
"partitionId": 217,
"created": "2022-04-13T15:42:05.901Z",
"user": null,
"read": true,
"document": null,
"retentionDate": "2022-04-13",
"daysUntilExpiry": 157,
"url": "string",
"mailjetTemplateName": "string",
"displayCode": "string",
"mailjetTemplateVars": {},
"mailjetTemplateEmail": null,
"createdInstant": "2022-04-13T15:42:05.901Z",
"name": "string",
"partition": null,
"idInPartition": 106,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"notifyEmail": "string",
"expirationNotified": true,
"retentionNotified": true,
"folders": null,
"comments": [
{
"id": 34,
"replyTo": null,
"createdDate": "2022-04-13T15:42:05.901Z",
"user": null,
"contact": null,
"text": "string",
"published": true,
"replies": null,
"ragStatus": "RED",
"node": {
"id": 13,
"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": 75,
"descendantComments": true,
"latestRagStatus": "RED",
"content": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=",
"xml": "string",
"endpointSummary": true,
"subject": null,
"definition": "string",
"template": true,
"display": "string",
"uuid": "string",
"treeFlattened": null,
"draftDossier": true,
"editFlaggable": true,
"category": true,
"creationDateFromString": "string",
"lastModificationDateFromString": "string",
"substance": true,
"idString": "string"
}
],
"changeType": "ADDED",
"commentCount": 156,
"descendantComments": true,
"latestRagStatus": "RED",
"display": "string",
"latestRagStatusDescendant": "RED",
"idString": "string"
},
"wrapperId": "string",
"wrapper": null,
"calendarSource": "PRODUCT",
"wrapperFallback": null,
"forTocEntry": true,
"tocEntry": {
"display": "string",
"changeType": "ADDED",
"latestRagStatus": "RED",
"commentCount": 76,
"descendantComments": true,
"idString": "string"
},
"name": "string",
"partition": null,
"idInPartition": 16,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"hidden": true,
"reply": true,
"serverCreatedReadableDate": "string",
"replyToIsUnpublished": true,
"createdBy": null,
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedById": 104,
"allDay": true,
"calendarEnd": "2022-04-13T15:42:05.901Z",
"calendarExtendedProps": {}
}
],
"searchedVia": null,
"integration": {
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 141,
"created": "2022-04-13T15:42:05.901Z",
"type": "BOCOUNT_EXPORT_INVOICES",
"name": "string",
"host": "string",
"principal": "string",
"tokenTransient": "string",
"tokenExpires": "2022-04-13T15:42:05.901Z",
"authType": "PLAIN",
"entity": null,
"iuclidDocuments": null,
"partitionId": 152,
"display": "string",
"tokenExpired": true,
"tokenEncrypted": "string",
"refreshTokenEncrypted": "string",
"tokenExpiring": true,
"credentialPresent": true,
"credentialEncrypted": "string",
"refreshTokenExpired": true
},
"IUCLIDAuthor": "string",
"legalEntity": "string",
"creationDate": "2022-04-13",
"uuid": "string",
"context": {
"id": 40,
"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",
"relevantUuid": "string"
},
"iuclidauthor": "string",
"index": 157,
"documentTask": null,
"partitionId": 43,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z"
},
"commentsPermission": "ROLE_PRE_AUTH",
"commentsEditPermission": "ROLE_PRE_AUTH",
"commentDisplayUrl": "string",
"hidden": true,
"allUsers": true,
"restrictedToConstituent": true,
"restrictedToCompanies": true,
"restrictedToContactGroup": true,
"associationRestricted": true,
"restrictedToAssociations": true,
"associatedAccessDisplay": "string",
"relationshipCriteriaDisplay": "string",
"contactGroupRestrictionDisplay": "string",
"association": "CONSTITUENT",
"associatedRecord": null,
"watching": true,
"watchers": null,
"partitionId": 236,
"partition": null,
"idInPartition": 204,
"display": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"iconColour": "string"
}
],
"name": "string",
"commentType": "string",
"commentsPermission": "ROLE_PRE_AUTH",
"commentsEditPermission": "ROLE_PRE_AUTH",
"commentDisplayUrl": "string",
"productIds": [
76
],
"constituentIds": [
291
],
"studyIds": [
279
],
"entityIds": [
123
],
"lastUpdatedById": 274,
"url": "string",
"partitionId": 294,
"partition": null,
"idInPartition": 229,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"emailCode": "string",
"emailPrefix": "string",
"oneToOne": true,
"watching": true,
"watchers": null
}
],
"documentLinkAttachments": null,
"deleted": true,
"deletedDate": "2022-04-13T15:42:05.901Z",
"fileId": "f2169c00-42b8-4784-a3cf-5866a15eb76e",
"watchingUsers": null,
"expiryNotifications": [
{
"id": 257,
"partitionId": 230,
"created": "2022-04-13T15:42:05.901Z",
"user": null,
"read": true,
"document": null,
"expiryDate": "2022-04-13",
"daysUntilExpiry": 97,
"drc": true,
"url": "string",
"mailjetTemplateName": "string",
"displayCode": "string",
"mailjetTemplateVars": {},
"mailjetTemplateEmail": null,
"createdInstant": "2022-04-13T15:42:05.901Z",
"name": "string",
"partition": null,
"idInPartition": 191,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"retentionNotifications": null,
"notifyEmail": "string",
"expirationNotified": true,
"retentionNotified": true,
"folders": null,
"taskLinks": null,
"taskTwoLinks": null,
"constituentTonnages": [
{
"id": 174,
"reachLegislation": "AUSTRALIA_AICIS",
"registration": {
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 54,
"constituent": null,
"reachLegislation": "AUSTRALIA_AICIS",
"source": "INTERNAL",
"legalEntity": null,
"forEntity": null,
"forEntityUuid": "string",
"submissionNumber": "string",
"registrationNumber": "string",
"registrationName": "string",
"registrationDate": "2022-04-13",
"registrationNotes": "string",
"publicName": "string",
"submissionDate": "2022-04-13",
"iuclidUUID": "string",
"reachRole": "MANUFACTURER",
"registrationRole": "LEAD",
"registrationStatus": "ACTIVE",
"originEntity": null,
"onlyRepresentative": null,
"preregistrationName": "string",
"preregistrationNumber": "string",
"preregistrationDate": "2022-04-13",
"preregisteredTonnageBand": "BAND_1",
"notePreregistered": "string",
"exemptionType": "EXEMPTION",
"exemption": "string",
"exemptionClaimed": "string",
"exemptionComment": "string",
"exemptionDocuments": null,
"reachITRegistrations": [
{
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 121,
"reachRegistration": null,
"dateSubmitted": "2022-04-13",
"dateIssued": "2022-04-13",
"dateAccepted": "2022-04-13",
"reachDossierType": "AU_IND_CHEM_ASSESS",
"tonnageBand": "BAND_1",
"reason": "CEASE_OF_MANUFACTURE",
"notes": "string",
"iuclidDossierReference": "string",
"communicationReference": "string",
"submissionNumber": "string",
"status": "DRAFT",
"supportingDocument": null,
"created": "2022-04-13T15:42:05.901Z",
"partitionId": 28,
"constituent": null,
"legalEntity": null,
"leadRegistrant": null,
"forEntity": null
}
],
"registeredTonnageBands": [
{
"id": 263,
"reachRegistration": null,
"registeredTonnageBand": "BAND_1",
"start": "2022-04-13",
"url": "string",
"allDay": true,
"calendarStart": "2022-04-13T15:42:05.901Z",
"calendarDisplay": "string",
"calendarSource": "PRODUCT",
"calendarEnd": "2022-04-13T15:42:05.901Z",
"calendarExtendedProps": {},
"name": "string",
"partitionId": 274,
"partition": null,
"idInPartition": 75,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"preregistered": true,
"enquiryNumber": "string",
"ppordNumber": "string",
"submissionType": "GRANDFATHERED",
"reachDossierType": "AU_IND_CHEM_ASSESS",
"annex": "IV",
"constituentTonnages": null,
"entityBudgets": [
{
"id": 280,
"entity": null,
"registration": null,
"purchaseOrderNumber": "string",
"annex": "IV",
"role": "LEAD",
"shareType": "CUSTOM",
"percentage": 10.12,
"budget": {
"id": 277,
"clientPartition": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdated": "2022-04-13T15:42:05.901Z",
"name": "string",
"type": "COST_ALL",
"start": "2022-04-13",
"end": "2022-04-13",
"currency": "string",
"cost": 10.12,
"additionalShare": 71,
"externalRef": "string",
"description": "string",
"products": null,
"constituents": null,
"categoryGroups": null,
"entityBudgets": null,
"invoices": [
{
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 52,
"partition": null,
"title": "string",
"description": "string",
"fileName": "string",
"originalFileName": "string",
"link": true,
"fileSize": 196,
"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,
"products": null,
"constituents": null,
"categoryGroups": null,
"productGroups": null,
"entities": null,
"entityGroups": null,
"contactGroups": null,
"documentTagSet": null,
"linkedDocuments": null,
"version": 288,
"versionIdentifier": "string",
"currentDocumentId": 164,
"currentDocument": null,
"versions": null,
"newsItem": true,
"sourceEmail": null,
"internalSourceEmails": null,
"issues": null,
"documentLinkAttachments": null,
"deleted": true,
"deletedDate": "2022-04-13T15:42:05.901Z",
"fileId": "820a514e-ab94-4c46-b698-19143c9bdee8",
"watchingUsers": null,
"expiryNotifications": null,
"retentionNotifications": null,
"notifyEmail": "string",
"expirationNotified": true,
"retentionNotified": true,
"folders": null,
"taskLinks": null,
"taskTwoLinks": null,
"constituentTonnages": null,
"productTonnages": [
{
"id": 201,
"reachLegislation": "AUSTRALIA_AICIS",
"forEntity": null,
"product": null,
"formulation": {
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 214,
"product": null,
"constituent": null,
"def": "COMPOSITION",
"name": "string",
"remarks": "string",
"versions": [
{
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 84,
"composite": {
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 217,
"product": null,
"constituent": null,
"def": "COMPOSITION",
"name": "string",
"remarks": "string",
"created": "2022-04-13T15:42:05.901Z",
"createdBy": null,
"type": {
"id": 222,
"name": "string",
"supportsRange": true,
"supportsFreetext": true,
"supportsSubVersions": true,
"supportsTypes": "string",
"proportionTypes": [
"ADDITIVE"
],
"url": "string",
"partitionId": 74,
"partition": null,
"idInPartition": 238,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
},
"partitionId": 121,
"partition": null,
"display": "string",
"substance": {
"lastUpdated": "2022-04-13T15:42:05.901Z",
"defaultTonnageFormulation": null,
"name": "string",
"deleted": true,
"formulations": null,
"currentFormulations": null,
"supportsFormulations": true,
"latestFormulation": null,
"composites": null,
"compositeDef": "COMPOSITION",
"supportsCompositions": true,
"compositions": [
{
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 103,
"product": null,
"constituent": null,
"def": "COMPOSITION",
"name": "string",
"remarks": "string",
"created": "2022-04-13T15:42:05.901Z",
"createdBy": null,
"type": {
"id": 127,
"name": "string",
"supportsRange": true,
"supportsFreetext": true,
"supportsSubVersions": true,
"supportsTypes": "string",
"proportionTypes": [
"ADDITIVE"
],
"url": "string",
"partitionId": 15,
"partition": null,
"idInPartition": 98,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
},
"partitionId": 139,
"partition": null,
"display": "string",
"substance": null,
"latestVersion": null,
"current": true,
"currentVersion": null,
"supportsRange": true,
"url": "string",
"idInPartition": 6,
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"lastUpdatedById": 269
}
],
"id": {},
"url": "string",
"partitionId": 198,
"partition": null,
"idInPartition": 132,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
},
"latestVersion": null,
"current": true,
"currentVersion": null,
"supportsRange": true,
"url": "string",
"idInPartition": 132,
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"lastUpdatedById": 295
},
"number": 66,
"start": "2022-04-13",
"end": "2022-04-13",
"remarks": "string",
"childProportions": [
{
"lastUpdated": "2022-04-13T15:42:05.901Z",
"id": 183,
"parentVersion": null,
"childConstituent": null,
"childVersion": null,
"childName": "string",
"type": "ADDITIVE",
"lowerOperator": "LT",
"lowerPercentage": 10.12,
"upperOperator": "LT",
"upperPercentage": 10.12,
"percentage": 10.12,
"created": "2022-04-13T15:42:05.901Z",
"createdBy": null,
"parentCompositeProportion": null,
"partitionId": 48
}
],
"parentProportions": null,
"created": "2022-04-13T15:42:05.901Z",
"createdBy": null,
"compositeType": null,
"partitionId": 187,
"partition": null,
"display": "string",
"constituent": null,
"substance": null,
"product": null,
"latestVersion": null,
"current": true,
"currentVersion": null,
"descendantConstituents": null,
"contextProportions": null,
"descendantProportions": null,
"latest": true,
"name": "string",
"url": "string",
"idInPartition": 38,
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"lastUpdatedById": 100
}
],
"created": "2022-04-13T15:42:05.901Z",
"createdBy": null,
"type": {
"id": 74,
"name": "string",
"supportsRange": true,
"supportsFreetext": true,
"supportsSubVersions": true,
"supportsTypes": "string",
"proportionTypes": [
"ADDITIVE"
],
"url": "string",
"partitionId": 298,
"partition": null,
"idInPartition": 105,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
},
"productTonnages": null,
"constituentTonnages": null,
"partitionId": 178,
"partition": null,
"display": "string",
"substance": null,
"latestVersion": null,
"current": true,
"currentVersion": null,
"supportsRange": true,
"url": "string",
"idInPartition": 260,
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"lastUpdatedById": 18
},
"entryYear": 289,
"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,
"total": 10.12
}
],
"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": "AUSTRALIA_AICIS",
"subTotal": 10.12,
"vat": 10.12,
"invoiceAmount": 10.12,
"outstandingAmount": 10.12,
"dateReceived": "2022-04-13",
"approved": true,
"approvedDate": "2022-04-13",
"approvedBy": null,
"sent": true,
"sentDate": "2022-04-13",
"sentBy": null,
"remarks": "string",
"invoiceOverdueDays": 66,
"overdueNotified": true,
"budgets": null,
"costSplits": [
{
"id": 126,
"document": null,
"cost": 10.12,
"product": null,
"constituent": null,
"categoryGroup": null,
"budget": null,
"study": null,
"records": [
{}
],
"costSameAsTotal": true
}
],
"overdueNotifications": [
{
"id": 223,
"partitionId": 61,
"created": "2022-04-13T15:42:05.901Z",
"user": null,
"read": true,
"invoice": null,
"invoiceDate": "2022-04-13",
"invoiceOverdueDays": 250,
"url": "string",
"mailjetTemplateName": "string",
"displayCode": "string",
"mailjetTemplateVars": {},
"mailjetTemplateEmail": null,
"createdInstant": "2022-04-13T15:42:05.901Z",
"name": "string",
"partition": null,
"idInPartition": 175,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"paidNotifications": [
{
"id": 199,
"partitionId": 159,
"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,
"createdInstant": "2022-04-13T15:42:05.901Z",
"name": "string",
"partition": null,
"idInPartition": 181,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"lines": [
{
"description": "string",
"amount": 10.12,
"salesCode": "string",
"account": "string",
"department": "string",
"taxed": true
}
],
"convertedSubTotal": 10.12,
"paid": true,
"relatedStudies": null,
"index": 287,
"documentTask": null,
"partitionId": 284,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z"
}
],
"comments": [
{
"id": 102,
"replyTo": null,
"createdDate": "2022-04-13T15:42:05.901Z",
"user": null,
"contact": null,
"text": "string",
"published": true,
"replies": null,
"ragStatus": "RED",
"hidden": true,
"reply": true,
"serverCreatedReadableDate": "string",
"replyToIsUnpublished": true,
"createdBy": null,
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedById": 99,
"name": "string",
"partition": null,
"idInPartition": 141,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"allDay": true,
"calendarSource": "PRODUCT",
"calendarEnd": "2022-04-13T15:42:05.901Z",
"calendarExtendedProps": {}
}
],
"entities": null,
"pages": null,
"budgetType": "COST_ALL",
"costsShared": true,
"commentType": "string",
"watching": true,
"watchers": null,
"watchingUsers": null,
"commentsPermission": "ROLE_PRE_AUTH",
"commentsEditPermission": "ROLE_PRE_AUTH",
"commentDisplayUrl": "string",
"url": "string",
"partitionId": 72,
"partition": null,
"idInPartition": 217,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"currencyInstance": {
"currencyCode": "string",
"numericCodeAsString": "string",
"displayName": "string",
"symbol": "string",
"defaultFractionDigits": 120,
"numericCode": 155
},
"constituentsFallback": null,
"additionalShareDecimal": 10.12,
"lastUpdatedById": 129
},
"interest": null,
"constituent": null,
"costShare": true,
"percentageDecimal": 10.12,
"journal": "MEM_S_CN"
}
],
"entityStudies": [
{
"id": 163,
"entity": null,
"registration": null,
"purchaseOrderNumber": "string",
"annex": "IV",
"role": "LEAD",
"shareType": "CUSTOM",
"percentage": 10.12,
"study": null,
"display": "string",
"interest": null,
"displayAttributes": [
{}
],
"sharedWithOthers": true,
"createdBy": null,
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedById": 243,
"name": "string",
"url": "string",
"partitionId": 127,
"partition": null,
"idInPartition": 92,
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"constituent": null,
"costShare": true,
"percentageDecimal": 10.12,
"journal": "MEM_S_CN"
}
],
"entityStudyGroups": [
{
"id": 137,
"entity": null,
"registration": null,
"purchaseOrderNumber": "string",
"annex": "IV",
"role": "LEAD",
"shareType": "CUSTOM",
"percentage": 10.12,
"group": {
"id": 26,
"clientPartition": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdated": "2022-04-13T15:42:05.901Z",
"name": "string",
"description": "string",
"studies": null,
"entityStudyGroups": null,
"overriddenStudies": null,
"activities": [
{
"id": 187,
"group": null,
"name": "string",
"planned": "2022-04-13"
}
],
"watchingUsers": null,
"comments": [
{
"id": 114,
"replyTo": null,
"createdDate": "2022-04-13T15:42:05.901Z",
"user": null,
"contact": null,
"text": "string",
"published": true,
"replies": null,
"ragStatus": "RED",
"calendarSource": "PRODUCT",
"hidden": true,
"reply": true,
"serverCreatedReadableDate": "string",
"replyToIsUnpublished": true,
"createdBy": null,
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedById": 118,
"name": "string",
"partition": null,
"idInPartition": 70,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"allDay": true,
"calendarEnd": "2022-04-13T15:42:05.901Z",
"calendarExtendedProps": {}
}
],
"currency": "string",
"externalRef": "string",
"studiesCount": 77,
"commentsPermission": "ROLE_PRE_AUTH",
"commentsEditPermission": "ROLE_PRE_AUTH",
"commentDisplayUrl": "string",
"currencyInstance": {
"currencyCode": "string",
"numericCodeAsString": "string",
"displayName": "string",
"symbol": "string",
"defaultFractionDigits": 85,
"numericCode": 66
},
"products": null,
"constituentsFallback": null,
"additionalShare": 249,
"budgetType": "COST_ALL",
"additionalShareDecimal": 10.12,
"url": "string",
"partitionId": 283,
"partition": null,
"idInPartition": 243,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"commentType": "string",
"watching": true,
"watchers": null,
"lastUpdatedById": 172
},
"interest": null,
"constituent": null,
"costShare": true,
"percentageDecimal": 10.12,
"journal": "MEM_S_CN"
}
],
"created": "2022-04-13T15:42:05.901Z",
"partitionId": 184,
"exempt": true,
"displayForInterest": "string"
},
"formulation": null,
"percentage": 10.12,
"constituent": null,
"entryYear": 42,
"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,
"tonnesManufactured": 10.12,
"tonnesImported": 10.12,
"total": 10.12
}
],
"productTonnages": null,
"submissions": null,
"comments": null,
"searchedVia": null,
"emailDate": "2022-04-13T15:42:05.901Z",
"sender": "string",
"recipients": [
{
"id": 226,
"type": "TO",
"firstName": "string",
"secondName": "string",
"emailAddress": "string",
"documentEmailInternal": null,
"contact": null,
"deleted": true,
"fullName": "string",
"domain": "string",
"entities": null
}
],
"subject": "string",
"emailBody": "string",
"attachments": null,
"privatise": true,
"fromTemplate": true,
"cc": "string",
"bcc": "string",
"saveAsDraft": true,
"duplicates": null,
"index": 166,
"documentTask": null,
"partitionId": 78,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z"
}
],
"issues": null,
"documentLinkAttachments": null,
"deleted": true,
"deletedDate": "2022-04-13T15:42:05.901Z",
"fileId": "956bf964-4a55-4838-af12-4b814f460274",
"watchingUsers": null,
"expiryNotifications": null,
"retentionNotifications": null,
"notifyEmail": "string",
"expirationNotified": true,
"retentionNotified": true,
"folders": null,
"taskLinks": null,
"taskTwoLinks": null,
"constituentTonnages": null,
"productTonnages": null,
"submissions": 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",
"attachments": null,
"missingAttachments": [
{
"id": 184,
"receivedEmail": {
"id": 239,
"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": "4d3ec5f4-58de-401c-af3e-8a707452fc41",
"filename": "string",
"docType": "DOCUMENT",
"savedDocument": null,
"likelySignatureImage": true
}
],
"attachmentsToSave": null,
"index": 74,
"documentTask": null,
"partitionId": 42,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z"
}
],
"internalSourceEmails": null,
"issues": null,
"documentLinkAttachments": null,
"deleted": true,
"deletedDate": "2022-04-13T15:42:05.901Z",
"fileId": "9ddec79b-426b-4afe-aee7-3dc6fc3202c4",
"watchingUsers": null,
"expiryNotifications": null,
"retentionNotifications": null,
"notifyEmail": "string",
"expirationNotified": true,
"retentionNotified": true,
"folders": null,
"taskLinks": null,
"taskTwoLinks": null,
"constituentTonnages": null,
"productTonnages": null,
"submissions": null,
"comments": null,
"searchedVia": null,
"index": 288,
"documentTask": null,
"partitionId": 161,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z"
},
"dateDownloaded": "2022-04-13",
"documentLinks": null
}
],
"expiryDays": 0,
"clientPartition": null,
"allDownloaded": true,
"link": "string",
"autoExpire": true,
"reminderDate": "2022-04-13",
"dateAllDownLoaded": "2022-04-13T15:42:05.901Z",
"emails": null,
"tonnageAndUseEnquiries": null,
"reminderDatePassed": true
},
"documentEmailInternals": null,
"products": null,
"tonnageAndUseImporters": [
{
"id": 266,
"name": "string",
"address": "string",
"contactPerson": "string",
"email": "string",
"telephone": "string",
"tauiProducts": [
{
"id": 57,
"tonnageAndUseEnquiryProductUses": [
{
"id": 150,
"tonnageAndUseImporter": null,
"useUuid": "d69b0ec0-b9ff-4613-b094-aac32909951a",
"puStatus": "x",
"usePercentage": 10.12,
"selected": true,
"remarks": "string"
}
],
"customUses": [
{
"id": 185,
"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": 213,
"fileName": "string",
"fileId": "e7c45254-0913-4f4c-b4ad-5bff53772d68"
}
],
"clientPartition": null,
"id": 217,
"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": 213,
"createdAsTonnageEnquiry": true,
"removeBracketedTextFromProductName": true,
"entityRole": null
}
],
"testingLaboratoryContacts": [
{
"id": 104,
"testingLaboratory": {
"id": 132,
"clientPartition": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdated": "2022-04-13T15:42:05.901Z",
"study": null,
"testingLaboratoryEntity": null,
"contacts": null,
"studyNumbers": [
{
"id": 37,
"testingLaboratory": null,
"activity": "string",
"contractRef": "string",
"studyNumber": "string",
"cost": 10.12,
"publishedCost": 10.12,
"payments": [
{
"id": 263,
"name": "string",
"estimatedDate": "2022-04-13",
"cost": 10.12,
"percentage": 10.12,
"studyNumber": null,
"type": "SCHEDULED",
"record": null,
"yearMonth": "string",
"year": 262,
"yearQuarter": {
"left": 0,
"right": 263,
"value": 81,
"key": 187
},
"quarter": 210
}
],
"publishedPayments": [
{
"id": 291,
"name": "string",
"estimatedDate": "2022-04-13",
"cost": 10.12,
"percentage": 10.12,
"studyNumber": null,
"type": "SCHEDULED",
"record": null,
"yearMonth": "string",
"year": 259,
"yearQuarter": null,
"quarter": 82
}
],
"activities": [
{
"id": 159,
"studyNumber": null,
"name": "string",
"autoPlannedAfter": 198,
"autoPlannedAfterPrevious": 255,
"planned": "2022-04-13",
"completed": "2022-04-13",
"signedBy": null,
"editable": true,
"template": {
"id": 42,
"timelineTemplate": {
"id": 83,
"name": "string",
"activityTemplates": null
},
"name": "string",
"autoPlannedAfter": 201,
"autoPlannedAfterPrevious": 209,
"sortOrder": 87,
"responsible": "CRO",
"activities": null
},
"comments": [
{
"id": 228,
"replyTo": null,
"createdDate": "2022-04-13T15:42:05.901Z",
"user": null,
"contact": null,
"text": "string",
"published": true,
"replies": null,
"ragStatus": "RED",
"calendarSource": "PRODUCT",
"hidden": true,
"reply": true,
"serverCreatedReadableDate": "string",
"replyToIsUnpublished": true,
"createdBy": null,
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedById": 155,
"name": "string",
"partition": null,
"idInPartition": 240,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"allDay": true,
"calendarEnd": "2022-04-13T15:42:05.901Z",
"calendarExtendedProps": {}
}
],
"overdueNotifications": [
{
"id": 228,
"partitionId": 113,
"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,
"createdInstant": "2022-04-13T15:42:05.901Z",
"name": "string",
"partition": null,
"idInPartition": 125,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"overdueNotified": true,
"inheritingGroupActivities": null,
"commentType": "string",
"status": "COMPLETED",
"url": "string",
"partitionId": 268,
"commentCount": 128,
"allDay": true,
"recordName": "string",
"calendarStart": "2022-04-13T15:42:05.901Z",
"calendarExtendedProps": {},
"commentsPermission": "ROLE_PRE_AUTH",
"commentsEditPermission": "ROLE_PRE_AUTH",
"commentDisplayUrl": "string",
"daysOverdue": 100,
"overdue": true,
"inheritingGroupNames": [
"string"
],
"multipleInheritanceDates": true,
"fromTemplate": true,
"autoPlannedAfterPreviousFallback": 268,
"createdBy": null,
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedById": 211,
"partition": null,
"idInPartition": 94,
"display": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string",
"calendarSource": "PRODUCT",
"calendarEnd": "2022-04-13T15:42:05.901Z",
"watching": true,
"watchingUsers": null
}
],
"display": "string",
"study": null,
"emptyCosts": true,
"activityStudyNumber": "string",
"createdBy": null,
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedById": 279,
"name": "string",
"url": "string",
"partitionId": 212,
"partition": null,
"idInPartition": 221,
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"evaluations": [
{
"id": 62,
"metric": {
"id": 205,
"name": "string"
},
"score": "VERY_POOR"
}
],
"evaluationNotes": "string",
"display": "string",
"displayAttributes": [
{}
],
"studyDirectors": null,
"lastUpdatedById": 118,
"name": "string",
"url": "string",
"partitionId": 12,
"partition": null,
"idInPartition": 143,
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
},
"role": "BUSINESS_DEVELOPMENT_MANAGER",
"contact": null,
"display": "string",
"displayAttributes": [
{}
],
"createdBy": null,
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedById": 200,
"name": "string",
"url": "string",
"partitionId": 273,
"partition": null,
"idInPartition": 58,
"recordName": "string",
"displayCodePartial": "string",
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"analyticalSamples": [
{
"id": 66,
"studyBeingEditedOrImported": 233,
"studies": null,
"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": 69,
"analyticalSample": null,
"analyticalMethod": "AAS"
}
],
"analysis": "2022-04-13",
"linkedDocument": null,
"subConstituents": [
{
"id": 77,
"analyticalSample": null,
"name": "string",
"casNumber": "string",
"ecNumber": "string",
"carbonNumber": 253,
"inclusionPercent": 10.12,
"type": [
{
"id": 9,
"subConstituent": null,
"subConstituentType": {
"id": 26,
"typeText": "string"
},
"ordinalPosition": 200,
"typeText": "string"
}
],
"typeText": "string",
"exportIndex": 56
}
],
"entity": null,
"analyticalMethodsOnly": [
"AAS"
],
"folderName": "string"
}
],
"documentLinks": null,
"contactRecipients": null,
"campaignContacts": null,
"tasks": null,
"pages": null,
"events": null,
"selected": true,
"selectable": true,
"fullName": "string",
"partitionId": 55
},
"secondaryInvoicingContact": null,
"watchingUsers": null,
"registrationsSubmitter": null,
"registrationsFor": null,
"partitionId": 133,
"selected": true,
"primaryInvoicingContactToImport": "string",
"secondaryInvoicingContactToImport": "string",
"testContacts": null,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z"
},
"role": {
"id": 196,
"name": "string",
"deletable": true,
"permissions": [
"ROLE_PRE_AUTH"
],
"externalGroups": [
"string"
],
"forCampaign": true,
"forInternal": true,
"penmanAdmin": true,
"defaultNoAccess": true,
"admin": true
},
"forcePasswordChange": true,
"termsAccepted": true,
"calendarDashboard": true,
"clientPortal": true,
"eligible": true,
"securityVersion": 0,
"defaultTimeZone": "string",
"showNewUi": true,
"uiBannerDismissed": true,
"initials": "string",
"active": true,
"fullName": "string",
"fullNameSanitized": "string",
"entityGroups": null,
"credentialsType": "BASIC",
"nameReversed": "string",
"temporaryPasswordActive": true,
"createdBy": null,
"lastUpdatedById": 171,
"name": "string",
"url": "string",
"partitionId": 118,
"partition": null,
"idInPartition": 217,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"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,
"defaultBudgetType": "COST_ALL",
"accessType": "PUBLIC",
"invoiceOverdueDays": 49,
"invoiceTemplate": "string",
"docExpiryNotificationDays": 240,
"deactivatedMessage": "string",
"partitionStudyCode": "string",
"clientPortalUrl": "string",
"supportEmail": "string",
"countries": null,
"pages": null,
"campaignTasks": null,
"campaignImages": [
{
"id": 150,
"clientPartition": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdated": "2022-04-13T15:42:05.901Z",
"campaign": null,
"fileId": "b77dbee1-0f22-45e5-a555-ce39745ca118",
"fileName": "string",
"lastUpdatedById": 131,
"name": "string",
"url": "string",
"partitionId": 262,
"partition": null,
"idInPartition": 24,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"integrations": null,
"name": "string",
"public": true,
"private": true,
"onlyPublicAccessForUser": true,
"campaignNavigationLevel": 275,
"expand": true,
"menuIndex": 273,
"pc": true,
"recordName": "string",
"studyAdditionalSharePercent": 93,
"menuParent": null,
"menuAncestors": null,
"url": "string",
"partitionId": 45,
"partition": null,
"idInPartition": 136,
"display": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
},
"idInPartition": 201,
"display": "string",
"recordName": "string",
"displayCodePartial": "string",
"displayAttributes": [
{}
],
"displayArgs": [
"string"
],
"breadcrumbParent": null,
"iconClass": "string",
"iconColour": "string"
}
],
"constituent": null,
"entity": null,
"entityInterests": [
{
"id": 167,
"entity": null,
"registration": null,
"purchaseOrderNumber": "string",
"annex": "IV",
"role": "LEAD",
"shareType": "CUSTOM",
"percentage": 10.12,
"constituent": null,
"costShare": true,
"interest": null,
"percentageDecimal": 10.12,
"journal": "MEM_S_CN"
}
],
"year": 144,
"quarter": 65,
"month": "JANUARY",
"currency": {
"currencyCode": "string",
"numericCodeAsString": "string",
"displayName": "string",
"symbol": "string",
"defaultFractionDigits": 203,
"numericCode": 290
},
"costTotal": 10.12,
"costs": {},
"costActual": 10.12,
"invoicedIn": 10.12,
"paid": 10.12,
"invoicedOut": 10.12,
"invoicedOutToEntity": 10.12,
"paidIn": 10.12,
"paidInByEntity": 10.12,
"outgoingInvoices": null,
"categoryGroups": null,
"summaries": [
{
"summary": {
"record": null,
"costTotalByType": {},
"costActualTotal": 10.12,
"invoicedInTotal": 10.12,
"paidOutTotal": 10.12,
"invoicedOutTotal": 10.12,
"paidInTotal": 10.12,
"baseShares": {},
"reducedShares": {},
"baseCostActualShare": 10.12,
"reducedCostActualShare": 10.12,
"baseInvoicedInShare": 10.12,
"reducedInvoicedInShare": 10.12,
"basePaidOutShare": 10.12,
"reducedPaidOutShare": 10.12,
"baseInvoicedOutShare": 10.12,
"reducedInvoicedOutShare": 10.12,
"basePaidInShare": 10.12,
"reducedPaidInShare": 10.12,
"costTotal": 10.12,
"shares": {}
},
"interest": null,
"costs": {},
"costActual": 10.12,
"invoicedIn": 10.12,
"paidOut": 10.12,
"invoicedOut": 10.12,
"paidIn": 10.12,
"entity": null,
"record": null,
"constituentOfInterest": null
}
],
"appliesFrom": "2022-04-13",
"monthDisplay": "string",
"reasonsForInterest": [
"string"
],
"registrationNumbers": [
"string"
],
"roleDisplays": [
"string"
],
"invoicedOutstanding": 10.12,
"balanceIn": 10.12,
"costVsActualString": "string",
"purchaseOrderNumbers": [
"string"
],
"entities": null,
"record": null,
"balanceForEntity": 10.12,
"cost": 10.12,
"invoicedOutstandingForEntity": 10.12,
"registrations": null,
"appliesTo": "2022-04-13",
"balance": 10.12,
"constituentsOfInterest": null,
"constituentOfInterest": null,
"entityInterest": null,
"journal": "MEM_S_CN"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/CostOverviewRow"
}
}
Registrations¶
GET /api/registrations/{id}¶
Get a Registration
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"reachLegislation": "EU_REACH",
"type": "INTERNAL",
"submittingLegalEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"forLegalEntity": null,
"forLegalEntityUuid": "37b58a8c-fae4-485f-bb99-1cf879d34678",
"status": "ACTIVE",
"registrationName": "Calcium dihydroxide",
"registrationNumber": "01-2119475151-45-1000",
"registrationDate": "2022-04-13",
"registrationRole": "MEMBER",
"annex": "VIII",
"publicName": "Calcium dihydroxide",
"reachRole": "MANUFACTURER",
"enquiryNumber": "06-1111111111-11-1111",
"ppordNumber": "04-1111111111-11-1111",
"iuclidUUID": "U37b58a8c-fae4-485f-bb99-1cf666d34678",
"registrationNotes": "Registration is complete.",
"reachDossierType": "A",
"preregistered": true,
"preregistrationName": "Calcium dihydroxide",
"preregistrationNumber": "05-1122334455-66-0001",
"preregistrationDate": "2022-04-13",
"preregistrationNote": "Preregistration complete.",
"exempt": true,
"exemptionType": "ANNEXIV",
"exemption": "dangerous",
"exemptionComment": "Marked as Exempt.",
"effectiveAnnex": "VIII"
}
Schema of the response body
{
"required": [
"constituent",
"reachLegislation",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"reachLegislation": {
"type": "string",
"example": "EU_REACH",
"enum": [
"AUSTRALIA_AICIS",
"BIOCIDES",
"BRAZIL_REACH",
"CANADA_CEPA",
"CHILE_REACH",
"CHINA",
"COLOMBIA_REACH",
"EU_CLP",
"EU_FSA",
"EU_DWD",
"EU_FCM",
"EU_PPP",
"EU_REACH",
"EU_TSR",
"EURASIA_REACH",
"INDIA_REACH",
"IRIS",
"JAPAN_CSCL",
"K_REACH",
"NZ_HSNO",
"OECD_HPV",
"OSHA",
"OSPAR",
"PHILIPPINE_APMPIN",
"SARA",
"SWISS_REACH",
"TAIWAN_REACH",
"TURKEY_REACH",
"UK_REACH",
"UKRAINE_REACH",
"US_TSCA",
"OTHER",
"NO_REGULATION"
]
},
"type": {
"type": "string",
"enum": [
"INTERNAL",
"EXTERNAL"
]
},
"submittingLegalEntity": {
"$ref": "#/components/schemas/EntityData"
},
"forLegalEntity": {
"$ref": "#/components/schemas/EntityData"
},
"forLegalEntityUuid": {
"type": "string",
"example": "37b58a8c-fae4-485f-bb99-1cf879d34678"
},
"status": {
"type": "string",
"example": "ACTIVE",
"enum": [
"ACTIVE",
"INACTIVE",
"SANCTIONED"
]
},
"registrationName": {
"type": "string",
"example": "Calcium dihydroxide"
},
"registrationNumber": {
"type": "string",
"example": "01-2119475151-45-1000"
},
"registrationDate": {
"type": "string",
"format": "date"
},
"registrationRole": {
"type": "string",
"example": "MEMBER",
"enum": [
"LEAD",
"MEMBER",
"INDIVIDUAL"
]
},
"annex": {
"type": "string",
"example": "VIII",
"enum": [
"IV",
"V",
"VI",
"VII",
"VIII",
"IX",
"X",
"XV"
]
},
"publicName": {
"type": "string",
"example": "Calcium dihydroxide"
},
"reachRole": {
"type": "string",
"example": "MANUFACTURER",
"enum": [
"MANUFACTURER",
"MANUFACTURER_IMPORTER",
"IMPORTER",
"ONLY_REPRESENTATIVE",
"DOWNSTREAM_USER"
]
},
"enquiryNumber": {
"type": "string",
"example": "06-1111111111-11-1111"
},
"ppordNumber": {
"type": "string",
"example": "04-1111111111-11-1111"
},
"iuclidUUID": {
"type": "string",
"example": "U37b58a8c-fae4-485f-bb99-1cf666d34678"
},
"registrationNotes": {
"type": "string",
"example": "Registration is complete."
},
"reachDossierType": {
"type": "string",
"example": "A",
"enum": [
"AU_IND_CHEM_ASSESS",
"AU_IND_CHEM_CERT_APPL_T1",
"AU_IND_CHEM_CERT_APPL_T2",
"AU_IND_CHEM_CERT_APPL_T3",
"AU_IND_CHEM_CERT_APPL_T4",
"AU_IND_CHEM_CERT_APPL_T5",
"AU_IND_CHEM_CEA",
"AU_IND_CHEM_PIR",
"BIOC_ACTIVE_SUBSTANCE_FOR_SUBSTANCES",
"BIOC_BASIC_INFORMATION",
"BIOC_BIOCIDAL_PRODUCT",
"BIOC_MICRO",
"BIOC_SUBSTANCE_OF_CONCERN",
"BIOC_SPC",
"BIOC_TECHNICAL_EQUIVALENCE",
"CLP_ALTERNATIVE_NAME",
"CLP_NOTIF",
"CLP_CLH",
"CLP_PCN_ICG",
"CLP_PCN_SFC",
"CLP_PCN",
"R_A15_SVHC",
"R_A15_REST",
"R_AUTH_APPL",
"R_DU_REPORT",
"R_SIA_NOTIF",
"R_1_10_PC",
"R_1_10_STD",
"R_10_100",
"R_100_1000",
"R_ABOVE_1000",
"R_JS_MBER",
"R_INT_JS_MBER",
"R_INT_ONSITE",
"R_INT_ONSITE_1_1000",
"R_INT_ONSITE_ABOVE_1000",
"R_SUB_EVAL",
"R_PPORD",
"R_INQUIRY",
"BIOC_ACTIVE_SUBSTANCE_FOR_MIXTURES",
"R_INT_TR_1_1000",
"R_INT_TR_ABOVE_1000",
"R_DU_NOTIF",
"R_MICROPLASTICS",
"DWD_ARTICLE_11_APPL",
"DWD_NIAS_OR_OTHER_SUBSTANCE",
"DWD_NOTIF",
"FCM_APPL",
"FCM_NIAS",
"EU_PPP_ACTIVE_SUBSTANCE_APP",
"EU_PPP_CA_ACTIVE_SUBSTANCE",
"EU_PPP_BASIC_SUBSTANCE",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS",
"EU_PPP_MICRO",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS_ACTIVE",
"EU_PPP_OTHER_MIXTURE",
"EU_PPP_OTHER_SUBSTANCE_ASSESSED",
"EU_PPP_PESTICIDE_PRODUCT",
"EU_PPP_SAFENERS_SYN_APP",
"EU_TSR_DEROGATION",
"K_REACH_INQUIRY",
"K_REACH_POLYMER_EXEMPTION",
"K_REACH_REAGENT_EXEMPTION",
"K_REACH_RD_EXEMPTION",
"K_REACH_EXPORT_EXEMPTION",
"K_REACH_SURFACE_TREATED_EXEMPTION",
"K_REACH_NON_ISOLATED_INT_EXEMPTION",
"K_REACH_ONSITE_INT_EXEMPTION",
"K_REACH_01_1",
"K_REACH_1_10",
"K_REACH_10_100",
"K_REACH_100_1000",
"K_REACH_ABOVE_1000",
"K_REACH_POLYMER_01_1",
"K_REACH_POLYMER_1_10",
"K_REACH_POLYMER_10_100",
"K_REACH_POLYMER_100_1000",
"K_REACH_POLYMER_ABOVE_1000",
"K_REACH_INT_ONSITE_01_1",
"K_REACH_INT_ONSITE_1_10",
"K_REACH_INT_ONSITE_10_100",
"K_REACH_INT_ONSITE_100_1000",
"K_REACH_INT_ONSITE_ABOVE_1000",
"K_REACH_INT_TR_01_1",
"K_REACH_INT_TR_1_10",
"K_REACH_INT_TR_10_100",
"K_REACH_INT_TR_100_1000",
"K_REACH_INT_TR_ABOVE_1000",
"K_REACH_EXEMPTION_CERT",
"K_REACH_REGISTRATION_CERT",
"K_REACH_HAZARD_EVAL",
"K_REACH_DU_REPORT",
"NZ_HSNO_APPL_FULL_ASSESS_CAT",
"NZ_HSNO_FULL_ASSESS_CAT",
"NZ_HSNO_LMTD_ASSESS_CAT",
"OECD_SIDS",
"OECD_HT_CAT"
]
},
"preregistered": {
"type": "boolean",
"example": true
},
"preregistrationName": {
"type": "string",
"example": "Calcium dihydroxide"
},
"preregistrationNumber": {
"type": "string",
"example": "05-1122334455-66-0001"
},
"preregistrationDate": {
"type": "string",
"format": "date"
},
"preregistrationNote": {
"type": "string",
"example": "Preregistration complete."
},
"exempt": {
"type": "boolean",
"example": true
},
"exemptionType": {
"type": "string",
"example": "ANNEXIV",
"enum": [
"EXEMPTION",
"ANNEXIV",
"ANNEXV",
"K_REACH_11",
"K_REACH_3",
"K_REACH_ANNEX_1",
"K_REACH_ANNEX_2"
]
},
"exemption": {
"type": "string",
"example": "dangerous"
},
"exemptionComment": {
"type": "string",
"example": "Marked as Exempt."
},
"effectiveAnnex": {
"type": "string",
"readOnly": true,
"example": "VIII",
"enum": [
"IV",
"V",
"VI",
"VII",
"VIII",
"IX",
"X",
"XV"
]
}
}
}
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
PUT /api/registrations/{id}¶
Fully Update a Registration
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"reachLegislation": "EU_REACH",
"type": "INTERNAL",
"submittingLegalEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"forLegalEntity": null,
"forLegalEntityUuid": "37b58a8c-fae4-485f-bb99-1cf879d34678",
"status": "ACTIVE",
"registrationName": "Calcium dihydroxide",
"registrationNumber": "01-2119475151-45-1000",
"registrationDate": "2022-04-13",
"registrationRole": "MEMBER",
"annex": "VIII",
"publicName": "Calcium dihydroxide",
"reachRole": "MANUFACTURER",
"enquiryNumber": "06-1111111111-11-1111",
"ppordNumber": "04-1111111111-11-1111",
"iuclidUUID": "U37b58a8c-fae4-485f-bb99-1cf666d34678",
"registrationNotes": "Registration is complete.",
"reachDossierType": "A",
"preregistered": true,
"preregistrationName": "Calcium dihydroxide",
"preregistrationNumber": "05-1122334455-66-0001",
"preregistrationDate": "2022-04-13",
"preregistrationNote": "Preregistration complete.",
"exempt": true,
"exemptionType": "ANNEXIV",
"exemption": "dangerous",
"exemptionComment": "Marked as Exempt.",
"effectiveAnnex": "VIII"
}
Schema of the request body
{
"required": [
"constituent",
"reachLegislation",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"reachLegislation": {
"type": "string",
"example": "EU_REACH",
"enum": [
"AUSTRALIA_AICIS",
"BIOCIDES",
"BRAZIL_REACH",
"CANADA_CEPA",
"CHILE_REACH",
"CHINA",
"COLOMBIA_REACH",
"EU_CLP",
"EU_FSA",
"EU_DWD",
"EU_FCM",
"EU_PPP",
"EU_REACH",
"EU_TSR",
"EURASIA_REACH",
"INDIA_REACH",
"IRIS",
"JAPAN_CSCL",
"K_REACH",
"NZ_HSNO",
"OECD_HPV",
"OSHA",
"OSPAR",
"PHILIPPINE_APMPIN",
"SARA",
"SWISS_REACH",
"TAIWAN_REACH",
"TURKEY_REACH",
"UK_REACH",
"UKRAINE_REACH",
"US_TSCA",
"OTHER",
"NO_REGULATION"
]
},
"type": {
"type": "string",
"enum": [
"INTERNAL",
"EXTERNAL"
]
},
"submittingLegalEntity": {
"$ref": "#/components/schemas/EntityData"
},
"forLegalEntity": {
"$ref": "#/components/schemas/EntityData"
},
"forLegalEntityUuid": {
"type": "string",
"example": "37b58a8c-fae4-485f-bb99-1cf879d34678"
},
"status": {
"type": "string",
"example": "ACTIVE",
"enum": [
"ACTIVE",
"INACTIVE",
"SANCTIONED"
]
},
"registrationName": {
"type": "string",
"example": "Calcium dihydroxide"
},
"registrationNumber": {
"type": "string",
"example": "01-2119475151-45-1000"
},
"registrationDate": {
"type": "string",
"format": "date"
},
"registrationRole": {
"type": "string",
"example": "MEMBER",
"enum": [
"LEAD",
"MEMBER",
"INDIVIDUAL"
]
},
"annex": {
"type": "string",
"example": "VIII",
"enum": [
"IV",
"V",
"VI",
"VII",
"VIII",
"IX",
"X",
"XV"
]
},
"publicName": {
"type": "string",
"example": "Calcium dihydroxide"
},
"reachRole": {
"type": "string",
"example": "MANUFACTURER",
"enum": [
"MANUFACTURER",
"MANUFACTURER_IMPORTER",
"IMPORTER",
"ONLY_REPRESENTATIVE",
"DOWNSTREAM_USER"
]
},
"enquiryNumber": {
"type": "string",
"example": "06-1111111111-11-1111"
},
"ppordNumber": {
"type": "string",
"example": "04-1111111111-11-1111"
},
"iuclidUUID": {
"type": "string",
"example": "U37b58a8c-fae4-485f-bb99-1cf666d34678"
},
"registrationNotes": {
"type": "string",
"example": "Registration is complete."
},
"reachDossierType": {
"type": "string",
"example": "A",
"enum": [
"AU_IND_CHEM_ASSESS",
"AU_IND_CHEM_CERT_APPL_T1",
"AU_IND_CHEM_CERT_APPL_T2",
"AU_IND_CHEM_CERT_APPL_T3",
"AU_IND_CHEM_CERT_APPL_T4",
"AU_IND_CHEM_CERT_APPL_T5",
"AU_IND_CHEM_CEA",
"AU_IND_CHEM_PIR",
"BIOC_ACTIVE_SUBSTANCE_FOR_SUBSTANCES",
"BIOC_BASIC_INFORMATION",
"BIOC_BIOCIDAL_PRODUCT",
"BIOC_MICRO",
"BIOC_SUBSTANCE_OF_CONCERN",
"BIOC_SPC",
"BIOC_TECHNICAL_EQUIVALENCE",
"CLP_ALTERNATIVE_NAME",
"CLP_NOTIF",
"CLP_CLH",
"CLP_PCN_ICG",
"CLP_PCN_SFC",
"CLP_PCN",
"R_A15_SVHC",
"R_A15_REST",
"R_AUTH_APPL",
"R_DU_REPORT",
"R_SIA_NOTIF",
"R_1_10_PC",
"R_1_10_STD",
"R_10_100",
"R_100_1000",
"R_ABOVE_1000",
"R_JS_MBER",
"R_INT_JS_MBER",
"R_INT_ONSITE",
"R_INT_ONSITE_1_1000",
"R_INT_ONSITE_ABOVE_1000",
"R_SUB_EVAL",
"R_PPORD",
"R_INQUIRY",
"BIOC_ACTIVE_SUBSTANCE_FOR_MIXTURES",
"R_INT_TR_1_1000",
"R_INT_TR_ABOVE_1000",
"R_DU_NOTIF",
"R_MICROPLASTICS",
"DWD_ARTICLE_11_APPL",
"DWD_NIAS_OR_OTHER_SUBSTANCE",
"DWD_NOTIF",
"FCM_APPL",
"FCM_NIAS",
"EU_PPP_ACTIVE_SUBSTANCE_APP",
"EU_PPP_CA_ACTIVE_SUBSTANCE",
"EU_PPP_BASIC_SUBSTANCE",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS",
"EU_PPP_MICRO",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS_ACTIVE",
"EU_PPP_OTHER_MIXTURE",
"EU_PPP_OTHER_SUBSTANCE_ASSESSED",
"EU_PPP_PESTICIDE_PRODUCT",
"EU_PPP_SAFENERS_SYN_APP",
"EU_TSR_DEROGATION",
"K_REACH_INQUIRY",
"K_REACH_POLYMER_EXEMPTION",
"K_REACH_REAGENT_EXEMPTION",
"K_REACH_RD_EXEMPTION",
"K_REACH_EXPORT_EXEMPTION",
"K_REACH_SURFACE_TREATED_EXEMPTION",
"K_REACH_NON_ISOLATED_INT_EXEMPTION",
"K_REACH_ONSITE_INT_EXEMPTION",
"K_REACH_01_1",
"K_REACH_1_10",
"K_REACH_10_100",
"K_REACH_100_1000",
"K_REACH_ABOVE_1000",
"K_REACH_POLYMER_01_1",
"K_REACH_POLYMER_1_10",
"K_REACH_POLYMER_10_100",
"K_REACH_POLYMER_100_1000",
"K_REACH_POLYMER_ABOVE_1000",
"K_REACH_INT_ONSITE_01_1",
"K_REACH_INT_ONSITE_1_10",
"K_REACH_INT_ONSITE_10_100",
"K_REACH_INT_ONSITE_100_1000",
"K_REACH_INT_ONSITE_ABOVE_1000",
"K_REACH_INT_TR_01_1",
"K_REACH_INT_TR_1_10",
"K_REACH_INT_TR_10_100",
"K_REACH_INT_TR_100_1000",
"K_REACH_INT_TR_ABOVE_1000",
"K_REACH_EXEMPTION_CERT",
"K_REACH_REGISTRATION_CERT",
"K_REACH_HAZARD_EVAL",
"K_REACH_DU_REPORT",
"NZ_HSNO_APPL_FULL_ASSESS_CAT",
"NZ_HSNO_FULL_ASSESS_CAT",
"NZ_HSNO_LMTD_ASSESS_CAT",
"OECD_SIDS",
"OECD_HT_CAT"
]
},
"preregistered": {
"type": "boolean",
"example": true
},
"preregistrationName": {
"type": "string",
"example": "Calcium dihydroxide"
},
"preregistrationNumber": {
"type": "string",
"example": "05-1122334455-66-0001"
},
"preregistrationDate": {
"type": "string",
"format": "date"
},
"preregistrationNote": {
"type": "string",
"example": "Preregistration complete."
},
"exempt": {
"type": "boolean",
"example": true
},
"exemptionType": {
"type": "string",
"example": "ANNEXIV",
"enum": [
"EXEMPTION",
"ANNEXIV",
"ANNEXV",
"K_REACH_11",
"K_REACH_3",
"K_REACH_ANNEX_1",
"K_REACH_ANNEX_2"
]
},
"exemption": {
"type": "string",
"example": "dangerous"
},
"exemptionComment": {
"type": "string",
"example": "Marked as Exempt."
},
"effectiveAnnex": {
"type": "string",
"readOnly": true,
"example": "VIII",
"enum": [
"IV",
"V",
"VI",
"VII",
"VIII",
"IX",
"X",
"XV"
]
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"reachLegislation": "EU_REACH",
"type": "INTERNAL",
"submittingLegalEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"forLegalEntity": null,
"forLegalEntityUuid": "37b58a8c-fae4-485f-bb99-1cf879d34678",
"status": "ACTIVE",
"registrationName": "Calcium dihydroxide",
"registrationNumber": "01-2119475151-45-1000",
"registrationDate": "2022-04-13",
"registrationRole": "MEMBER",
"annex": "VIII",
"publicName": "Calcium dihydroxide",
"reachRole": "MANUFACTURER",
"enquiryNumber": "06-1111111111-11-1111",
"ppordNumber": "04-1111111111-11-1111",
"iuclidUUID": "U37b58a8c-fae4-485f-bb99-1cf666d34678",
"registrationNotes": "Registration is complete.",
"reachDossierType": "A",
"preregistered": true,
"preregistrationName": "Calcium dihydroxide",
"preregistrationNumber": "05-1122334455-66-0001",
"preregistrationDate": "2022-04-13",
"preregistrationNote": "Preregistration complete.",
"exempt": true,
"exemptionType": "ANNEXIV",
"exemption": "dangerous",
"exemptionComment": "Marked as Exempt.",
"effectiveAnnex": "VIII"
}
Schema of the response body
{
"required": [
"constituent",
"reachLegislation",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"reachLegislation": {
"type": "string",
"example": "EU_REACH",
"enum": [
"AUSTRALIA_AICIS",
"BIOCIDES",
"BRAZIL_REACH",
"CANADA_CEPA",
"CHILE_REACH",
"CHINA",
"COLOMBIA_REACH",
"EU_CLP",
"EU_FSA",
"EU_DWD",
"EU_FCM",
"EU_PPP",
"EU_REACH",
"EU_TSR",
"EURASIA_REACH",
"INDIA_REACH",
"IRIS",
"JAPAN_CSCL",
"K_REACH",
"NZ_HSNO",
"OECD_HPV",
"OSHA",
"OSPAR",
"PHILIPPINE_APMPIN",
"SARA",
"SWISS_REACH",
"TAIWAN_REACH",
"TURKEY_REACH",
"UK_REACH",
"UKRAINE_REACH",
"US_TSCA",
"OTHER",
"NO_REGULATION"
]
},
"type": {
"type": "string",
"enum": [
"INTERNAL",
"EXTERNAL"
]
},
"submittingLegalEntity": {
"$ref": "#/components/schemas/EntityData"
},
"forLegalEntity": {
"$ref": "#/components/schemas/EntityData"
},
"forLegalEntityUuid": {
"type": "string",
"example": "37b58a8c-fae4-485f-bb99-1cf879d34678"
},
"status": {
"type": "string",
"example": "ACTIVE",
"enum": [
"ACTIVE",
"INACTIVE",
"SANCTIONED"
]
},
"registrationName": {
"type": "string",
"example": "Calcium dihydroxide"
},
"registrationNumber": {
"type": "string",
"example": "01-2119475151-45-1000"
},
"registrationDate": {
"type": "string",
"format": "date"
},
"registrationRole": {
"type": "string",
"example": "MEMBER",
"enum": [
"LEAD",
"MEMBER",
"INDIVIDUAL"
]
},
"annex": {
"type": "string",
"example": "VIII",
"enum": [
"IV",
"V",
"VI",
"VII",
"VIII",
"IX",
"X",
"XV"
]
},
"publicName": {
"type": "string",
"example": "Calcium dihydroxide"
},
"reachRole": {
"type": "string",
"example": "MANUFACTURER",
"enum": [
"MANUFACTURER",
"MANUFACTURER_IMPORTER",
"IMPORTER",
"ONLY_REPRESENTATIVE",
"DOWNSTREAM_USER"
]
},
"enquiryNumber": {
"type": "string",
"example": "06-1111111111-11-1111"
},
"ppordNumber": {
"type": "string",
"example": "04-1111111111-11-1111"
},
"iuclidUUID": {
"type": "string",
"example": "U37b58a8c-fae4-485f-bb99-1cf666d34678"
},
"registrationNotes": {
"type": "string",
"example": "Registration is complete."
},
"reachDossierType": {
"type": "string",
"example": "A",
"enum": [
"AU_IND_CHEM_ASSESS",
"AU_IND_CHEM_CERT_APPL_T1",
"AU_IND_CHEM_CERT_APPL_T2",
"AU_IND_CHEM_CERT_APPL_T3",
"AU_IND_CHEM_CERT_APPL_T4",
"AU_IND_CHEM_CERT_APPL_T5",
"AU_IND_CHEM_CEA",
"AU_IND_CHEM_PIR",
"BIOC_ACTIVE_SUBSTANCE_FOR_SUBSTANCES",
"BIOC_BASIC_INFORMATION",
"BIOC_BIOCIDAL_PRODUCT",
"BIOC_MICRO",
"BIOC_SUBSTANCE_OF_CONCERN",
"BIOC_SPC",
"BIOC_TECHNICAL_EQUIVALENCE",
"CLP_ALTERNATIVE_NAME",
"CLP_NOTIF",
"CLP_CLH",
"CLP_PCN_ICG",
"CLP_PCN_SFC",
"CLP_PCN",
"R_A15_SVHC",
"R_A15_REST",
"R_AUTH_APPL",
"R_DU_REPORT",
"R_SIA_NOTIF",
"R_1_10_PC",
"R_1_10_STD",
"R_10_100",
"R_100_1000",
"R_ABOVE_1000",
"R_JS_MBER",
"R_INT_JS_MBER",
"R_INT_ONSITE",
"R_INT_ONSITE_1_1000",
"R_INT_ONSITE_ABOVE_1000",
"R_SUB_EVAL",
"R_PPORD",
"R_INQUIRY",
"BIOC_ACTIVE_SUBSTANCE_FOR_MIXTURES",
"R_INT_TR_1_1000",
"R_INT_TR_ABOVE_1000",
"R_DU_NOTIF",
"R_MICROPLASTICS",
"DWD_ARTICLE_11_APPL",
"DWD_NIAS_OR_OTHER_SUBSTANCE",
"DWD_NOTIF",
"FCM_APPL",
"FCM_NIAS",
"EU_PPP_ACTIVE_SUBSTANCE_APP",
"EU_PPP_CA_ACTIVE_SUBSTANCE",
"EU_PPP_BASIC_SUBSTANCE",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS",
"EU_PPP_MICRO",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS_ACTIVE",
"EU_PPP_OTHER_MIXTURE",
"EU_PPP_OTHER_SUBSTANCE_ASSESSED",
"EU_PPP_PESTICIDE_PRODUCT",
"EU_PPP_SAFENERS_SYN_APP",
"EU_TSR_DEROGATION",
"K_REACH_INQUIRY",
"K_REACH_POLYMER_EXEMPTION",
"K_REACH_REAGENT_EXEMPTION",
"K_REACH_RD_EXEMPTION",
"K_REACH_EXPORT_EXEMPTION",
"K_REACH_SURFACE_TREATED_EXEMPTION",
"K_REACH_NON_ISOLATED_INT_EXEMPTION",
"K_REACH_ONSITE_INT_EXEMPTION",
"K_REACH_01_1",
"K_REACH_1_10",
"K_REACH_10_100",
"K_REACH_100_1000",
"K_REACH_ABOVE_1000",
"K_REACH_POLYMER_01_1",
"K_REACH_POLYMER_1_10",
"K_REACH_POLYMER_10_100",
"K_REACH_POLYMER_100_1000",
"K_REACH_POLYMER_ABOVE_1000",
"K_REACH_INT_ONSITE_01_1",
"K_REACH_INT_ONSITE_1_10",
"K_REACH_INT_ONSITE_10_100",
"K_REACH_INT_ONSITE_100_1000",
"K_REACH_INT_ONSITE_ABOVE_1000",
"K_REACH_INT_TR_01_1",
"K_REACH_INT_TR_1_10",
"K_REACH_INT_TR_10_100",
"K_REACH_INT_TR_100_1000",
"K_REACH_INT_TR_ABOVE_1000",
"K_REACH_EXEMPTION_CERT",
"K_REACH_REGISTRATION_CERT",
"K_REACH_HAZARD_EVAL",
"K_REACH_DU_REPORT",
"NZ_HSNO_APPL_FULL_ASSESS_CAT",
"NZ_HSNO_FULL_ASSESS_CAT",
"NZ_HSNO_LMTD_ASSESS_CAT",
"OECD_SIDS",
"OECD_HT_CAT"
]
},
"preregistered": {
"type": "boolean",
"example": true
},
"preregistrationName": {
"type": "string",
"example": "Calcium dihydroxide"
},
"preregistrationNumber": {
"type": "string",
"example": "05-1122334455-66-0001"
},
"preregistrationDate": {
"type": "string",
"format": "date"
},
"preregistrationNote": {
"type": "string",
"example": "Preregistration complete."
},
"exempt": {
"type": "boolean",
"example": true
},
"exemptionType": {
"type": "string",
"example": "ANNEXIV",
"enum": [
"EXEMPTION",
"ANNEXIV",
"ANNEXV",
"K_REACH_11",
"K_REACH_3",
"K_REACH_ANNEX_1",
"K_REACH_ANNEX_2"
]
},
"exemption": {
"type": "string",
"example": "dangerous"
},
"exemptionComment": {
"type": "string",
"example": "Marked as Exempt."
},
"effectiveAnnex": {
"type": "string",
"readOnly": true,
"example": "VIII",
"enum": [
"IV",
"V",
"VI",
"VII",
"VIII",
"IX",
"X",
"XV"
]
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
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,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"reachLegislation": "EU_REACH",
"type": "INTERNAL",
"submittingLegalEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"forLegalEntity": null,
"forLegalEntityUuid": "37b58a8c-fae4-485f-bb99-1cf879d34678",
"status": "ACTIVE",
"registrationName": "Calcium dihydroxide",
"registrationNumber": "01-2119475151-45-1000",
"registrationDate": "2022-04-13",
"registrationRole": "MEMBER",
"annex": "VIII",
"publicName": "Calcium dihydroxide",
"reachRole": "MANUFACTURER",
"enquiryNumber": "06-1111111111-11-1111",
"ppordNumber": "04-1111111111-11-1111",
"iuclidUUID": "U37b58a8c-fae4-485f-bb99-1cf666d34678",
"registrationNotes": "Registration is complete.",
"reachDossierType": "A",
"preregistered": true,
"preregistrationName": "Calcium dihydroxide",
"preregistrationNumber": "05-1122334455-66-0001",
"preregistrationDate": "2022-04-13",
"preregistrationNote": "Preregistration complete.",
"exempt": true,
"exemptionType": "ANNEXIV",
"exemption": "dangerous",
"exemptionComment": "Marked as Exempt.",
"effectiveAnnex": "VIII"
}
Schema of the request body
{
"required": [
"constituent",
"reachLegislation",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"reachLegislation": {
"type": "string",
"example": "EU_REACH",
"enum": [
"AUSTRALIA_AICIS",
"BIOCIDES",
"BRAZIL_REACH",
"CANADA_CEPA",
"CHILE_REACH",
"CHINA",
"COLOMBIA_REACH",
"EU_CLP",
"EU_FSA",
"EU_DWD",
"EU_FCM",
"EU_PPP",
"EU_REACH",
"EU_TSR",
"EURASIA_REACH",
"INDIA_REACH",
"IRIS",
"JAPAN_CSCL",
"K_REACH",
"NZ_HSNO",
"OECD_HPV",
"OSHA",
"OSPAR",
"PHILIPPINE_APMPIN",
"SARA",
"SWISS_REACH",
"TAIWAN_REACH",
"TURKEY_REACH",
"UK_REACH",
"UKRAINE_REACH",
"US_TSCA",
"OTHER",
"NO_REGULATION"
]
},
"type": {
"type": "string",
"enum": [
"INTERNAL",
"EXTERNAL"
]
},
"submittingLegalEntity": {
"$ref": "#/components/schemas/EntityData"
},
"forLegalEntity": {
"$ref": "#/components/schemas/EntityData"
},
"forLegalEntityUuid": {
"type": "string",
"example": "37b58a8c-fae4-485f-bb99-1cf879d34678"
},
"status": {
"type": "string",
"example": "ACTIVE",
"enum": [
"ACTIVE",
"INACTIVE",
"SANCTIONED"
]
},
"registrationName": {
"type": "string",
"example": "Calcium dihydroxide"
},
"registrationNumber": {
"type": "string",
"example": "01-2119475151-45-1000"
},
"registrationDate": {
"type": "string",
"format": "date"
},
"registrationRole": {
"type": "string",
"example": "MEMBER",
"enum": [
"LEAD",
"MEMBER",
"INDIVIDUAL"
]
},
"annex": {
"type": "string",
"example": "VIII",
"enum": [
"IV",
"V",
"VI",
"VII",
"VIII",
"IX",
"X",
"XV"
]
},
"publicName": {
"type": "string",
"example": "Calcium dihydroxide"
},
"reachRole": {
"type": "string",
"example": "MANUFACTURER",
"enum": [
"MANUFACTURER",
"MANUFACTURER_IMPORTER",
"IMPORTER",
"ONLY_REPRESENTATIVE",
"DOWNSTREAM_USER"
]
},
"enquiryNumber": {
"type": "string",
"example": "06-1111111111-11-1111"
},
"ppordNumber": {
"type": "string",
"example": "04-1111111111-11-1111"
},
"iuclidUUID": {
"type": "string",
"example": "U37b58a8c-fae4-485f-bb99-1cf666d34678"
},
"registrationNotes": {
"type": "string",
"example": "Registration is complete."
},
"reachDossierType": {
"type": "string",
"example": "A",
"enum": [
"AU_IND_CHEM_ASSESS",
"AU_IND_CHEM_CERT_APPL_T1",
"AU_IND_CHEM_CERT_APPL_T2",
"AU_IND_CHEM_CERT_APPL_T3",
"AU_IND_CHEM_CERT_APPL_T4",
"AU_IND_CHEM_CERT_APPL_T5",
"AU_IND_CHEM_CEA",
"AU_IND_CHEM_PIR",
"BIOC_ACTIVE_SUBSTANCE_FOR_SUBSTANCES",
"BIOC_BASIC_INFORMATION",
"BIOC_BIOCIDAL_PRODUCT",
"BIOC_MICRO",
"BIOC_SUBSTANCE_OF_CONCERN",
"BIOC_SPC",
"BIOC_TECHNICAL_EQUIVALENCE",
"CLP_ALTERNATIVE_NAME",
"CLP_NOTIF",
"CLP_CLH",
"CLP_PCN_ICG",
"CLP_PCN_SFC",
"CLP_PCN",
"R_A15_SVHC",
"R_A15_REST",
"R_AUTH_APPL",
"R_DU_REPORT",
"R_SIA_NOTIF",
"R_1_10_PC",
"R_1_10_STD",
"R_10_100",
"R_100_1000",
"R_ABOVE_1000",
"R_JS_MBER",
"R_INT_JS_MBER",
"R_INT_ONSITE",
"R_INT_ONSITE_1_1000",
"R_INT_ONSITE_ABOVE_1000",
"R_SUB_EVAL",
"R_PPORD",
"R_INQUIRY",
"BIOC_ACTIVE_SUBSTANCE_FOR_MIXTURES",
"R_INT_TR_1_1000",
"R_INT_TR_ABOVE_1000",
"R_DU_NOTIF",
"R_MICROPLASTICS",
"DWD_ARTICLE_11_APPL",
"DWD_NIAS_OR_OTHER_SUBSTANCE",
"DWD_NOTIF",
"FCM_APPL",
"FCM_NIAS",
"EU_PPP_ACTIVE_SUBSTANCE_APP",
"EU_PPP_CA_ACTIVE_SUBSTANCE",
"EU_PPP_BASIC_SUBSTANCE",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS",
"EU_PPP_MICRO",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS_ACTIVE",
"EU_PPP_OTHER_MIXTURE",
"EU_PPP_OTHER_SUBSTANCE_ASSESSED",
"EU_PPP_PESTICIDE_PRODUCT",
"EU_PPP_SAFENERS_SYN_APP",
"EU_TSR_DEROGATION",
"K_REACH_INQUIRY",
"K_REACH_POLYMER_EXEMPTION",
"K_REACH_REAGENT_EXEMPTION",
"K_REACH_RD_EXEMPTION",
"K_REACH_EXPORT_EXEMPTION",
"K_REACH_SURFACE_TREATED_EXEMPTION",
"K_REACH_NON_ISOLATED_INT_EXEMPTION",
"K_REACH_ONSITE_INT_EXEMPTION",
"K_REACH_01_1",
"K_REACH_1_10",
"K_REACH_10_100",
"K_REACH_100_1000",
"K_REACH_ABOVE_1000",
"K_REACH_POLYMER_01_1",
"K_REACH_POLYMER_1_10",
"K_REACH_POLYMER_10_100",
"K_REACH_POLYMER_100_1000",
"K_REACH_POLYMER_ABOVE_1000",
"K_REACH_INT_ONSITE_01_1",
"K_REACH_INT_ONSITE_1_10",
"K_REACH_INT_ONSITE_10_100",
"K_REACH_INT_ONSITE_100_1000",
"K_REACH_INT_ONSITE_ABOVE_1000",
"K_REACH_INT_TR_01_1",
"K_REACH_INT_TR_1_10",
"K_REACH_INT_TR_10_100",
"K_REACH_INT_TR_100_1000",
"K_REACH_INT_TR_ABOVE_1000",
"K_REACH_EXEMPTION_CERT",
"K_REACH_REGISTRATION_CERT",
"K_REACH_HAZARD_EVAL",
"K_REACH_DU_REPORT",
"NZ_HSNO_APPL_FULL_ASSESS_CAT",
"NZ_HSNO_FULL_ASSESS_CAT",
"NZ_HSNO_LMTD_ASSESS_CAT",
"OECD_SIDS",
"OECD_HT_CAT"
]
},
"preregistered": {
"type": "boolean",
"example": true
},
"preregistrationName": {
"type": "string",
"example": "Calcium dihydroxide"
},
"preregistrationNumber": {
"type": "string",
"example": "05-1122334455-66-0001"
},
"preregistrationDate": {
"type": "string",
"format": "date"
},
"preregistrationNote": {
"type": "string",
"example": "Preregistration complete."
},
"exempt": {
"type": "boolean",
"example": true
},
"exemptionType": {
"type": "string",
"example": "ANNEXIV",
"enum": [
"EXEMPTION",
"ANNEXIV",
"ANNEXV",
"K_REACH_11",
"K_REACH_3",
"K_REACH_ANNEX_1",
"K_REACH_ANNEX_2"
]
},
"exemption": {
"type": "string",
"example": "dangerous"
},
"exemptionComment": {
"type": "string",
"example": "Marked as Exempt."
},
"effectiveAnnex": {
"type": "string",
"readOnly": true,
"example": "VIII",
"enum": [
"IV",
"V",
"VI",
"VII",
"VIII",
"IX",
"X",
"XV"
]
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"reachLegislation": "EU_REACH",
"type": "INTERNAL",
"submittingLegalEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"forLegalEntity": null,
"forLegalEntityUuid": "37b58a8c-fae4-485f-bb99-1cf879d34678",
"status": "ACTIVE",
"registrationName": "Calcium dihydroxide",
"registrationNumber": "01-2119475151-45-1000",
"registrationDate": "2022-04-13",
"registrationRole": "MEMBER",
"annex": "VIII",
"publicName": "Calcium dihydroxide",
"reachRole": "MANUFACTURER",
"enquiryNumber": "06-1111111111-11-1111",
"ppordNumber": "04-1111111111-11-1111",
"iuclidUUID": "U37b58a8c-fae4-485f-bb99-1cf666d34678",
"registrationNotes": "Registration is complete.",
"reachDossierType": "A",
"preregistered": true,
"preregistrationName": "Calcium dihydroxide",
"preregistrationNumber": "05-1122334455-66-0001",
"preregistrationDate": "2022-04-13",
"preregistrationNote": "Preregistration complete.",
"exempt": true,
"exemptionType": "ANNEXIV",
"exemption": "dangerous",
"exemptionComment": "Marked as Exempt.",
"effectiveAnnex": "VIII"
}
Schema of the response body
{
"required": [
"constituent",
"reachLegislation",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"reachLegislation": {
"type": "string",
"example": "EU_REACH",
"enum": [
"AUSTRALIA_AICIS",
"BIOCIDES",
"BRAZIL_REACH",
"CANADA_CEPA",
"CHILE_REACH",
"CHINA",
"COLOMBIA_REACH",
"EU_CLP",
"EU_FSA",
"EU_DWD",
"EU_FCM",
"EU_PPP",
"EU_REACH",
"EU_TSR",
"EURASIA_REACH",
"INDIA_REACH",
"IRIS",
"JAPAN_CSCL",
"K_REACH",
"NZ_HSNO",
"OECD_HPV",
"OSHA",
"OSPAR",
"PHILIPPINE_APMPIN",
"SARA",
"SWISS_REACH",
"TAIWAN_REACH",
"TURKEY_REACH",
"UK_REACH",
"UKRAINE_REACH",
"US_TSCA",
"OTHER",
"NO_REGULATION"
]
},
"type": {
"type": "string",
"enum": [
"INTERNAL",
"EXTERNAL"
]
},
"submittingLegalEntity": {
"$ref": "#/components/schemas/EntityData"
},
"forLegalEntity": {
"$ref": "#/components/schemas/EntityData"
},
"forLegalEntityUuid": {
"type": "string",
"example": "37b58a8c-fae4-485f-bb99-1cf879d34678"
},
"status": {
"type": "string",
"example": "ACTIVE",
"enum": [
"ACTIVE",
"INACTIVE",
"SANCTIONED"
]
},
"registrationName": {
"type": "string",
"example": "Calcium dihydroxide"
},
"registrationNumber": {
"type": "string",
"example": "01-2119475151-45-1000"
},
"registrationDate": {
"type": "string",
"format": "date"
},
"registrationRole": {
"type": "string",
"example": "MEMBER",
"enum": [
"LEAD",
"MEMBER",
"INDIVIDUAL"
]
},
"annex": {
"type": "string",
"example": "VIII",
"enum": [
"IV",
"V",
"VI",
"VII",
"VIII",
"IX",
"X",
"XV"
]
},
"publicName": {
"type": "string",
"example": "Calcium dihydroxide"
},
"reachRole": {
"type": "string",
"example": "MANUFACTURER",
"enum": [
"MANUFACTURER",
"MANUFACTURER_IMPORTER",
"IMPORTER",
"ONLY_REPRESENTATIVE",
"DOWNSTREAM_USER"
]
},
"enquiryNumber": {
"type": "string",
"example": "06-1111111111-11-1111"
},
"ppordNumber": {
"type": "string",
"example": "04-1111111111-11-1111"
},
"iuclidUUID": {
"type": "string",
"example": "U37b58a8c-fae4-485f-bb99-1cf666d34678"
},
"registrationNotes": {
"type": "string",
"example": "Registration is complete."
},
"reachDossierType": {
"type": "string",
"example": "A",
"enum": [
"AU_IND_CHEM_ASSESS",
"AU_IND_CHEM_CERT_APPL_T1",
"AU_IND_CHEM_CERT_APPL_T2",
"AU_IND_CHEM_CERT_APPL_T3",
"AU_IND_CHEM_CERT_APPL_T4",
"AU_IND_CHEM_CERT_APPL_T5",
"AU_IND_CHEM_CEA",
"AU_IND_CHEM_PIR",
"BIOC_ACTIVE_SUBSTANCE_FOR_SUBSTANCES",
"BIOC_BASIC_INFORMATION",
"BIOC_BIOCIDAL_PRODUCT",
"BIOC_MICRO",
"BIOC_SUBSTANCE_OF_CONCERN",
"BIOC_SPC",
"BIOC_TECHNICAL_EQUIVALENCE",
"CLP_ALTERNATIVE_NAME",
"CLP_NOTIF",
"CLP_CLH",
"CLP_PCN_ICG",
"CLP_PCN_SFC",
"CLP_PCN",
"R_A15_SVHC",
"R_A15_REST",
"R_AUTH_APPL",
"R_DU_REPORT",
"R_SIA_NOTIF",
"R_1_10_PC",
"R_1_10_STD",
"R_10_100",
"R_100_1000",
"R_ABOVE_1000",
"R_JS_MBER",
"R_INT_JS_MBER",
"R_INT_ONSITE",
"R_INT_ONSITE_1_1000",
"R_INT_ONSITE_ABOVE_1000",
"R_SUB_EVAL",
"R_PPORD",
"R_INQUIRY",
"BIOC_ACTIVE_SUBSTANCE_FOR_MIXTURES",
"R_INT_TR_1_1000",
"R_INT_TR_ABOVE_1000",
"R_DU_NOTIF",
"R_MICROPLASTICS",
"DWD_ARTICLE_11_APPL",
"DWD_NIAS_OR_OTHER_SUBSTANCE",
"DWD_NOTIF",
"FCM_APPL",
"FCM_NIAS",
"EU_PPP_ACTIVE_SUBSTANCE_APP",
"EU_PPP_CA_ACTIVE_SUBSTANCE",
"EU_PPP_BASIC_SUBSTANCE",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS",
"EU_PPP_MICRO",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS_ACTIVE",
"EU_PPP_OTHER_MIXTURE",
"EU_PPP_OTHER_SUBSTANCE_ASSESSED",
"EU_PPP_PESTICIDE_PRODUCT",
"EU_PPP_SAFENERS_SYN_APP",
"EU_TSR_DEROGATION",
"K_REACH_INQUIRY",
"K_REACH_POLYMER_EXEMPTION",
"K_REACH_REAGENT_EXEMPTION",
"K_REACH_RD_EXEMPTION",
"K_REACH_EXPORT_EXEMPTION",
"K_REACH_SURFACE_TREATED_EXEMPTION",
"K_REACH_NON_ISOLATED_INT_EXEMPTION",
"K_REACH_ONSITE_INT_EXEMPTION",
"K_REACH_01_1",
"K_REACH_1_10",
"K_REACH_10_100",
"K_REACH_100_1000",
"K_REACH_ABOVE_1000",
"K_REACH_POLYMER_01_1",
"K_REACH_POLYMER_1_10",
"K_REACH_POLYMER_10_100",
"K_REACH_POLYMER_100_1000",
"K_REACH_POLYMER_ABOVE_1000",
"K_REACH_INT_ONSITE_01_1",
"K_REACH_INT_ONSITE_1_10",
"K_REACH_INT_ONSITE_10_100",
"K_REACH_INT_ONSITE_100_1000",
"K_REACH_INT_ONSITE_ABOVE_1000",
"K_REACH_INT_TR_01_1",
"K_REACH_INT_TR_1_10",
"K_REACH_INT_TR_10_100",
"K_REACH_INT_TR_100_1000",
"K_REACH_INT_TR_ABOVE_1000",
"K_REACH_EXEMPTION_CERT",
"K_REACH_REGISTRATION_CERT",
"K_REACH_HAZARD_EVAL",
"K_REACH_DU_REPORT",
"NZ_HSNO_APPL_FULL_ASSESS_CAT",
"NZ_HSNO_FULL_ASSESS_CAT",
"NZ_HSNO_LMTD_ASSESS_CAT",
"OECD_SIDS",
"OECD_HT_CAT"
]
},
"preregistered": {
"type": "boolean",
"example": true
},
"preregistrationName": {
"type": "string",
"example": "Calcium dihydroxide"
},
"preregistrationNumber": {
"type": "string",
"example": "05-1122334455-66-0001"
},
"preregistrationDate": {
"type": "string",
"format": "date"
},
"preregistrationNote": {
"type": "string",
"example": "Preregistration complete."
},
"exempt": {
"type": "boolean",
"example": true
},
"exemptionType": {
"type": "string",
"example": "ANNEXIV",
"enum": [
"EXEMPTION",
"ANNEXIV",
"ANNEXV",
"K_REACH_11",
"K_REACH_3",
"K_REACH_ANNEX_1",
"K_REACH_ANNEX_2"
]
},
"exemption": {
"type": "string",
"example": "dangerous"
},
"exemptionComment": {
"type": "string",
"example": "Marked as Exempt."
},
"effectiveAnnex": {
"type": "string",
"readOnly": true,
"example": "VIII",
"enum": [
"IV",
"V",
"VI",
"VII",
"VIII",
"IX",
"X",
"XV"
]
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
GET /api/registrations¶
Get all Registrations
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
constituent |
query | integer | Yes | Filter registrations by constituent | |
page |
query | integer | 0 | Yes | Zero-based page index (0..N) |
size |
query | integer | 20 | Yes | The size of the page to be returned |
sort |
query | array | Yes | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Response 200 OK
{
"totalPages": 129,
"totalElements": 84,
"size": 72,
"content": [
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"reachLegislation": "EU_REACH",
"type": "INTERNAL",
"submittingLegalEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"forLegalEntity": null,
"forLegalEntityUuid": "37b58a8c-fae4-485f-bb99-1cf879d34678",
"status": "ACTIVE",
"registrationName": "Calcium dihydroxide",
"registrationNumber": "01-2119475151-45-1000",
"registrationDate": "2022-04-13",
"registrationRole": "MEMBER",
"annex": "VIII",
"publicName": "Calcium dihydroxide",
"reachRole": "MANUFACTURER",
"enquiryNumber": "06-1111111111-11-1111",
"ppordNumber": "04-1111111111-11-1111",
"iuclidUUID": "U37b58a8c-fae4-485f-bb99-1cf666d34678",
"registrationNotes": "Registration is complete.",
"reachDossierType": "A",
"preregistered": true,
"preregistrationName": "Calcium dihydroxide",
"preregistrationNumber": "05-1122334455-66-0001",
"preregistrationDate": "2022-04-13",
"preregistrationNote": "Preregistration complete.",
"exempt": true,
"exemptionType": "ANNEXIV",
"exemption": "dangerous",
"exemptionComment": "Marked as Exempt.",
"effectiveAnnex": "VIII"
}
],
"number": 274,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"pageable": {
"offset": 255,
"sort": null,
"unpaged": true,
"paged": true,
"pageSize": 2,
"pageNumber": 45
},
"numberOfElements": 217,
"first": true,
"last": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RegistrationData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
POST /api/registrations¶
Create a Registration
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"reachLegislation": "EU_REACH",
"type": "INTERNAL",
"submittingLegalEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"forLegalEntity": null,
"forLegalEntityUuid": "37b58a8c-fae4-485f-bb99-1cf879d34678",
"status": "ACTIVE",
"registrationName": "Calcium dihydroxide",
"registrationNumber": "01-2119475151-45-1000",
"registrationDate": "2022-04-13",
"registrationRole": "MEMBER",
"annex": "VIII",
"publicName": "Calcium dihydroxide",
"reachRole": "MANUFACTURER",
"enquiryNumber": "06-1111111111-11-1111",
"ppordNumber": "04-1111111111-11-1111",
"iuclidUUID": "U37b58a8c-fae4-485f-bb99-1cf666d34678",
"registrationNotes": "Registration is complete.",
"reachDossierType": "A",
"preregistered": true,
"preregistrationName": "Calcium dihydroxide",
"preregistrationNumber": "05-1122334455-66-0001",
"preregistrationDate": "2022-04-13",
"preregistrationNote": "Preregistration complete.",
"exempt": true,
"exemptionType": "ANNEXIV",
"exemption": "dangerous",
"exemptionComment": "Marked as Exempt.",
"effectiveAnnex": "VIII"
}
Schema of the request body
{
"required": [
"constituent",
"reachLegislation",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"reachLegislation": {
"type": "string",
"example": "EU_REACH",
"enum": [
"AUSTRALIA_AICIS",
"BIOCIDES",
"BRAZIL_REACH",
"CANADA_CEPA",
"CHILE_REACH",
"CHINA",
"COLOMBIA_REACH",
"EU_CLP",
"EU_FSA",
"EU_DWD",
"EU_FCM",
"EU_PPP",
"EU_REACH",
"EU_TSR",
"EURASIA_REACH",
"INDIA_REACH",
"IRIS",
"JAPAN_CSCL",
"K_REACH",
"NZ_HSNO",
"OECD_HPV",
"OSHA",
"OSPAR",
"PHILIPPINE_APMPIN",
"SARA",
"SWISS_REACH",
"TAIWAN_REACH",
"TURKEY_REACH",
"UK_REACH",
"UKRAINE_REACH",
"US_TSCA",
"OTHER",
"NO_REGULATION"
]
},
"type": {
"type": "string",
"enum": [
"INTERNAL",
"EXTERNAL"
]
},
"submittingLegalEntity": {
"$ref": "#/components/schemas/EntityData"
},
"forLegalEntity": {
"$ref": "#/components/schemas/EntityData"
},
"forLegalEntityUuid": {
"type": "string",
"example": "37b58a8c-fae4-485f-bb99-1cf879d34678"
},
"status": {
"type": "string",
"example": "ACTIVE",
"enum": [
"ACTIVE",
"INACTIVE",
"SANCTIONED"
]
},
"registrationName": {
"type": "string",
"example": "Calcium dihydroxide"
},
"registrationNumber": {
"type": "string",
"example": "01-2119475151-45-1000"
},
"registrationDate": {
"type": "string",
"format": "date"
},
"registrationRole": {
"type": "string",
"example": "MEMBER",
"enum": [
"LEAD",
"MEMBER",
"INDIVIDUAL"
]
},
"annex": {
"type": "string",
"example": "VIII",
"enum": [
"IV",
"V",
"VI",
"VII",
"VIII",
"IX",
"X",
"XV"
]
},
"publicName": {
"type": "string",
"example": "Calcium dihydroxide"
},
"reachRole": {
"type": "string",
"example": "MANUFACTURER",
"enum": [
"MANUFACTURER",
"MANUFACTURER_IMPORTER",
"IMPORTER",
"ONLY_REPRESENTATIVE",
"DOWNSTREAM_USER"
]
},
"enquiryNumber": {
"type": "string",
"example": "06-1111111111-11-1111"
},
"ppordNumber": {
"type": "string",
"example": "04-1111111111-11-1111"
},
"iuclidUUID": {
"type": "string",
"example": "U37b58a8c-fae4-485f-bb99-1cf666d34678"
},
"registrationNotes": {
"type": "string",
"example": "Registration is complete."
},
"reachDossierType": {
"type": "string",
"example": "A",
"enum": [
"AU_IND_CHEM_ASSESS",
"AU_IND_CHEM_CERT_APPL_T1",
"AU_IND_CHEM_CERT_APPL_T2",
"AU_IND_CHEM_CERT_APPL_T3",
"AU_IND_CHEM_CERT_APPL_T4",
"AU_IND_CHEM_CERT_APPL_T5",
"AU_IND_CHEM_CEA",
"AU_IND_CHEM_PIR",
"BIOC_ACTIVE_SUBSTANCE_FOR_SUBSTANCES",
"BIOC_BASIC_INFORMATION",
"BIOC_BIOCIDAL_PRODUCT",
"BIOC_MICRO",
"BIOC_SUBSTANCE_OF_CONCERN",
"BIOC_SPC",
"BIOC_TECHNICAL_EQUIVALENCE",
"CLP_ALTERNATIVE_NAME",
"CLP_NOTIF",
"CLP_CLH",
"CLP_PCN_ICG",
"CLP_PCN_SFC",
"CLP_PCN",
"R_A15_SVHC",
"R_A15_REST",
"R_AUTH_APPL",
"R_DU_REPORT",
"R_SIA_NOTIF",
"R_1_10_PC",
"R_1_10_STD",
"R_10_100",
"R_100_1000",
"R_ABOVE_1000",
"R_JS_MBER",
"R_INT_JS_MBER",
"R_INT_ONSITE",
"R_INT_ONSITE_1_1000",
"R_INT_ONSITE_ABOVE_1000",
"R_SUB_EVAL",
"R_PPORD",
"R_INQUIRY",
"BIOC_ACTIVE_SUBSTANCE_FOR_MIXTURES",
"R_INT_TR_1_1000",
"R_INT_TR_ABOVE_1000",
"R_DU_NOTIF",
"R_MICROPLASTICS",
"DWD_ARTICLE_11_APPL",
"DWD_NIAS_OR_OTHER_SUBSTANCE",
"DWD_NOTIF",
"FCM_APPL",
"FCM_NIAS",
"EU_PPP_ACTIVE_SUBSTANCE_APP",
"EU_PPP_CA_ACTIVE_SUBSTANCE",
"EU_PPP_BASIC_SUBSTANCE",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS",
"EU_PPP_MICRO",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS_ACTIVE",
"EU_PPP_OTHER_MIXTURE",
"EU_PPP_OTHER_SUBSTANCE_ASSESSED",
"EU_PPP_PESTICIDE_PRODUCT",
"EU_PPP_SAFENERS_SYN_APP",
"EU_TSR_DEROGATION",
"K_REACH_INQUIRY",
"K_REACH_POLYMER_EXEMPTION",
"K_REACH_REAGENT_EXEMPTION",
"K_REACH_RD_EXEMPTION",
"K_REACH_EXPORT_EXEMPTION",
"K_REACH_SURFACE_TREATED_EXEMPTION",
"K_REACH_NON_ISOLATED_INT_EXEMPTION",
"K_REACH_ONSITE_INT_EXEMPTION",
"K_REACH_01_1",
"K_REACH_1_10",
"K_REACH_10_100",
"K_REACH_100_1000",
"K_REACH_ABOVE_1000",
"K_REACH_POLYMER_01_1",
"K_REACH_POLYMER_1_10",
"K_REACH_POLYMER_10_100",
"K_REACH_POLYMER_100_1000",
"K_REACH_POLYMER_ABOVE_1000",
"K_REACH_INT_ONSITE_01_1",
"K_REACH_INT_ONSITE_1_10",
"K_REACH_INT_ONSITE_10_100",
"K_REACH_INT_ONSITE_100_1000",
"K_REACH_INT_ONSITE_ABOVE_1000",
"K_REACH_INT_TR_01_1",
"K_REACH_INT_TR_1_10",
"K_REACH_INT_TR_10_100",
"K_REACH_INT_TR_100_1000",
"K_REACH_INT_TR_ABOVE_1000",
"K_REACH_EXEMPTION_CERT",
"K_REACH_REGISTRATION_CERT",
"K_REACH_HAZARD_EVAL",
"K_REACH_DU_REPORT",
"NZ_HSNO_APPL_FULL_ASSESS_CAT",
"NZ_HSNO_FULL_ASSESS_CAT",
"NZ_HSNO_LMTD_ASSESS_CAT",
"OECD_SIDS",
"OECD_HT_CAT"
]
},
"preregistered": {
"type": "boolean",
"example": true
},
"preregistrationName": {
"type": "string",
"example": "Calcium dihydroxide"
},
"preregistrationNumber": {
"type": "string",
"example": "05-1122334455-66-0001"
},
"preregistrationDate": {
"type": "string",
"format": "date"
},
"preregistrationNote": {
"type": "string",
"example": "Preregistration complete."
},
"exempt": {
"type": "boolean",
"example": true
},
"exemptionType": {
"type": "string",
"example": "ANNEXIV",
"enum": [
"EXEMPTION",
"ANNEXIV",
"ANNEXV",
"K_REACH_11",
"K_REACH_3",
"K_REACH_ANNEX_1",
"K_REACH_ANNEX_2"
]
},
"exemption": {
"type": "string",
"example": "dangerous"
},
"exemptionComment": {
"type": "string",
"example": "Marked as Exempt."
},
"effectiveAnnex": {
"type": "string",
"readOnly": true,
"example": "VIII",
"enum": [
"IV",
"V",
"VI",
"VII",
"VIII",
"IX",
"X",
"XV"
]
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"reachLegislation": "EU_REACH",
"type": "INTERNAL",
"submittingLegalEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"forLegalEntity": null,
"forLegalEntityUuid": "37b58a8c-fae4-485f-bb99-1cf879d34678",
"status": "ACTIVE",
"registrationName": "Calcium dihydroxide",
"registrationNumber": "01-2119475151-45-1000",
"registrationDate": "2022-04-13",
"registrationRole": "MEMBER",
"annex": "VIII",
"publicName": "Calcium dihydroxide",
"reachRole": "MANUFACTURER",
"enquiryNumber": "06-1111111111-11-1111",
"ppordNumber": "04-1111111111-11-1111",
"iuclidUUID": "U37b58a8c-fae4-485f-bb99-1cf666d34678",
"registrationNotes": "Registration is complete.",
"reachDossierType": "A",
"preregistered": true,
"preregistrationName": "Calcium dihydroxide",
"preregistrationNumber": "05-1122334455-66-0001",
"preregistrationDate": "2022-04-13",
"preregistrationNote": "Preregistration complete.",
"exempt": true,
"exemptionType": "ANNEXIV",
"exemption": "dangerous",
"exemptionComment": "Marked as Exempt.",
"effectiveAnnex": "VIII"
}
Schema of the response body
{
"required": [
"constituent",
"reachLegislation",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"reachLegislation": {
"type": "string",
"example": "EU_REACH",
"enum": [
"AUSTRALIA_AICIS",
"BIOCIDES",
"BRAZIL_REACH",
"CANADA_CEPA",
"CHILE_REACH",
"CHINA",
"COLOMBIA_REACH",
"EU_CLP",
"EU_FSA",
"EU_DWD",
"EU_FCM",
"EU_PPP",
"EU_REACH",
"EU_TSR",
"EURASIA_REACH",
"INDIA_REACH",
"IRIS",
"JAPAN_CSCL",
"K_REACH",
"NZ_HSNO",
"OECD_HPV",
"OSHA",
"OSPAR",
"PHILIPPINE_APMPIN",
"SARA",
"SWISS_REACH",
"TAIWAN_REACH",
"TURKEY_REACH",
"UK_REACH",
"UKRAINE_REACH",
"US_TSCA",
"OTHER",
"NO_REGULATION"
]
},
"type": {
"type": "string",
"enum": [
"INTERNAL",
"EXTERNAL"
]
},
"submittingLegalEntity": {
"$ref": "#/components/schemas/EntityData"
},
"forLegalEntity": {
"$ref": "#/components/schemas/EntityData"
},
"forLegalEntityUuid": {
"type": "string",
"example": "37b58a8c-fae4-485f-bb99-1cf879d34678"
},
"status": {
"type": "string",
"example": "ACTIVE",
"enum": [
"ACTIVE",
"INACTIVE",
"SANCTIONED"
]
},
"registrationName": {
"type": "string",
"example": "Calcium dihydroxide"
},
"registrationNumber": {
"type": "string",
"example": "01-2119475151-45-1000"
},
"registrationDate": {
"type": "string",
"format": "date"
},
"registrationRole": {
"type": "string",
"example": "MEMBER",
"enum": [
"LEAD",
"MEMBER",
"INDIVIDUAL"
]
},
"annex": {
"type": "string",
"example": "VIII",
"enum": [
"IV",
"V",
"VI",
"VII",
"VIII",
"IX",
"X",
"XV"
]
},
"publicName": {
"type": "string",
"example": "Calcium dihydroxide"
},
"reachRole": {
"type": "string",
"example": "MANUFACTURER",
"enum": [
"MANUFACTURER",
"MANUFACTURER_IMPORTER",
"IMPORTER",
"ONLY_REPRESENTATIVE",
"DOWNSTREAM_USER"
]
},
"enquiryNumber": {
"type": "string",
"example": "06-1111111111-11-1111"
},
"ppordNumber": {
"type": "string",
"example": "04-1111111111-11-1111"
},
"iuclidUUID": {
"type": "string",
"example": "U37b58a8c-fae4-485f-bb99-1cf666d34678"
},
"registrationNotes": {
"type": "string",
"example": "Registration is complete."
},
"reachDossierType": {
"type": "string",
"example": "A",
"enum": [
"AU_IND_CHEM_ASSESS",
"AU_IND_CHEM_CERT_APPL_T1",
"AU_IND_CHEM_CERT_APPL_T2",
"AU_IND_CHEM_CERT_APPL_T3",
"AU_IND_CHEM_CERT_APPL_T4",
"AU_IND_CHEM_CERT_APPL_T5",
"AU_IND_CHEM_CEA",
"AU_IND_CHEM_PIR",
"BIOC_ACTIVE_SUBSTANCE_FOR_SUBSTANCES",
"BIOC_BASIC_INFORMATION",
"BIOC_BIOCIDAL_PRODUCT",
"BIOC_MICRO",
"BIOC_SUBSTANCE_OF_CONCERN",
"BIOC_SPC",
"BIOC_TECHNICAL_EQUIVALENCE",
"CLP_ALTERNATIVE_NAME",
"CLP_NOTIF",
"CLP_CLH",
"CLP_PCN_ICG",
"CLP_PCN_SFC",
"CLP_PCN",
"R_A15_SVHC",
"R_A15_REST",
"R_AUTH_APPL",
"R_DU_REPORT",
"R_SIA_NOTIF",
"R_1_10_PC",
"R_1_10_STD",
"R_10_100",
"R_100_1000",
"R_ABOVE_1000",
"R_JS_MBER",
"R_INT_JS_MBER",
"R_INT_ONSITE",
"R_INT_ONSITE_1_1000",
"R_INT_ONSITE_ABOVE_1000",
"R_SUB_EVAL",
"R_PPORD",
"R_INQUIRY",
"BIOC_ACTIVE_SUBSTANCE_FOR_MIXTURES",
"R_INT_TR_1_1000",
"R_INT_TR_ABOVE_1000",
"R_DU_NOTIF",
"R_MICROPLASTICS",
"DWD_ARTICLE_11_APPL",
"DWD_NIAS_OR_OTHER_SUBSTANCE",
"DWD_NOTIF",
"FCM_APPL",
"FCM_NIAS",
"EU_PPP_ACTIVE_SUBSTANCE_APP",
"EU_PPP_CA_ACTIVE_SUBSTANCE",
"EU_PPP_BASIC_SUBSTANCE",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS",
"EU_PPP_MICRO",
"EU_PPP_MAXIMUM_RESIDUE_LEVELS_ACTIVE",
"EU_PPP_OTHER_MIXTURE",
"EU_PPP_OTHER_SUBSTANCE_ASSESSED",
"EU_PPP_PESTICIDE_PRODUCT",
"EU_PPP_SAFENERS_SYN_APP",
"EU_TSR_DEROGATION",
"K_REACH_INQUIRY",
"K_REACH_POLYMER_EXEMPTION",
"K_REACH_REAGENT_EXEMPTION",
"K_REACH_RD_EXEMPTION",
"K_REACH_EXPORT_EXEMPTION",
"K_REACH_SURFACE_TREATED_EXEMPTION",
"K_REACH_NON_ISOLATED_INT_EXEMPTION",
"K_REACH_ONSITE_INT_EXEMPTION",
"K_REACH_01_1",
"K_REACH_1_10",
"K_REACH_10_100",
"K_REACH_100_1000",
"K_REACH_ABOVE_1000",
"K_REACH_POLYMER_01_1",
"K_REACH_POLYMER_1_10",
"K_REACH_POLYMER_10_100",
"K_REACH_POLYMER_100_1000",
"K_REACH_POLYMER_ABOVE_1000",
"K_REACH_INT_ONSITE_01_1",
"K_REACH_INT_ONSITE_1_10",
"K_REACH_INT_ONSITE_10_100",
"K_REACH_INT_ONSITE_100_1000",
"K_REACH_INT_ONSITE_ABOVE_1000",
"K_REACH_INT_TR_01_1",
"K_REACH_INT_TR_1_10",
"K_REACH_INT_TR_10_100",
"K_REACH_INT_TR_100_1000",
"K_REACH_INT_TR_ABOVE_1000",
"K_REACH_EXEMPTION_CERT",
"K_REACH_REGISTRATION_CERT",
"K_REACH_HAZARD_EVAL",
"K_REACH_DU_REPORT",
"NZ_HSNO_APPL_FULL_ASSESS_CAT",
"NZ_HSNO_FULL_ASSESS_CAT",
"NZ_HSNO_LMTD_ASSESS_CAT",
"OECD_SIDS",
"OECD_HT_CAT"
]
},
"preregistered": {
"type": "boolean",
"example": true
},
"preregistrationName": {
"type": "string",
"example": "Calcium dihydroxide"
},
"preregistrationNumber": {
"type": "string",
"example": "05-1122334455-66-0001"
},
"preregistrationDate": {
"type": "string",
"format": "date"
},
"preregistrationNote": {
"type": "string",
"example": "Preregistration complete."
},
"exempt": {
"type": "boolean",
"example": true
},
"exemptionType": {
"type": "string",
"example": "ANNEXIV",
"enum": [
"EXEMPTION",
"ANNEXIV",
"ANNEXV",
"K_REACH_11",
"K_REACH_3",
"K_REACH_ANNEX_1",
"K_REACH_ANNEX_2"
]
},
"exemption": {
"type": "string",
"example": "dangerous"
},
"exemptionComment": {
"type": "string",
"example": "Marked as Exempt."
},
"effectiveAnnex": {
"type": "string",
"readOnly": true,
"example": "VIII",
"enum": [
"IV",
"V",
"VI",
"VII",
"VIII",
"IX",
"X",
"XV"
]
}
}
}
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
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,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
}
Schema of the response body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Lubricant"
},
"ownerManufacturer": {
"type": "string",
"example": "Penman Consulting"
},
"archived": {
"type": "boolean",
"example": false
}
}
}
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
PUT /api/products/{id}¶
Fully Update a Product
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
}
Schema of the request body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Lubricant"
},
"ownerManufacturer": {
"type": "string",
"example": "Penman Consulting"
},
"archived": {
"type": "boolean",
"example": false
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
}
Schema of the response body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Lubricant"
},
"ownerManufacturer": {
"type": "string",
"example": "Penman Consulting"
},
"archived": {
"type": "boolean",
"example": false
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
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,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
}
Schema of the request body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Lubricant"
},
"ownerManufacturer": {
"type": "string",
"example": "Penman Consulting"
},
"archived": {
"type": "boolean",
"example": false
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
}
Schema of the response body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Lubricant"
},
"ownerManufacturer": {
"type": "string",
"example": "Penman Consulting"
},
"archived": {
"type": "boolean",
"example": false
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
GET /api/products¶
Get all Products
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
page |
query | integer | 0 | Yes | Zero-based page index (0..N) |
size |
query | integer | 20 | Yes | The size of the page to be returned |
sort |
query | array | Yes | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Response 200 OK
{
"totalPages": 15,
"totalElements": 54,
"size": 65,
"content": [
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
}
],
"number": 168,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"pageable": {
"offset": 120,
"sort": null,
"unpaged": true,
"paged": true,
"pageSize": 174,
"pageNumber": 3
},
"numberOfElements": 192,
"first": true,
"last": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
POST /api/products¶
Create a Product
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
}
Schema of the request body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Lubricant"
},
"ownerManufacturer": {
"type": "string",
"example": "Penman Consulting"
},
"archived": {
"type": "boolean",
"example": false
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
}
Schema of the response body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Lubricant"
},
"ownerManufacturer": {
"type": "string",
"example": "Penman Consulting"
},
"archived": {
"type": "boolean",
"example": false
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
Product Entity Links¶
GET /api/products/entities/{id}¶
Get a Product-Entity Link
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"roles": [
{
"display": "Registrant",
"id": "REGISTRANT"
}
],
"end": "2027-07-03",
"start": "2025-10-03"
}
Schema of the response body
{
"required": [
"entity",
"product"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"product": {
"$ref": "#/components/schemas/ProductData"
},
"entity": {
"$ref": "#/components/schemas/EntityData"
},
"roles": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityRoleData"
}
},
"end": {
"type": "string",
"format": "date",
"example": "2027-07-03"
},
"start": {
"type": "string",
"format": "date",
"example": "2025-10-03"
}
}
}
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
PUT /api/products/entities/{id}¶
Fully Update Product-Entity Link
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"roles": [
{
"display": "Registrant",
"id": "REGISTRANT"
}
],
"end": "2027-07-03",
"start": "2025-10-03"
}
Schema of the request body
{
"required": [
"entity",
"product"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"product": {
"$ref": "#/components/schemas/ProductData"
},
"entity": {
"$ref": "#/components/schemas/EntityData"
},
"roles": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityRoleData"
}
},
"end": {
"type": "string",
"format": "date",
"example": "2027-07-03"
},
"start": {
"type": "string",
"format": "date",
"example": "2025-10-03"
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"roles": [
{
"display": "Registrant",
"id": "REGISTRANT"
}
],
"end": "2027-07-03",
"start": "2025-10-03"
}
Schema of the response body
{
"required": [
"entity",
"product"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"product": {
"$ref": "#/components/schemas/ProductData"
},
"entity": {
"$ref": "#/components/schemas/EntityData"
},
"roles": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityRoleData"
}
},
"end": {
"type": "string",
"format": "date",
"example": "2027-07-03"
},
"start": {
"type": "string",
"format": "date",
"example": "2025-10-03"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
DELETE /api/products/entities/{id}¶
Delete Product-Entity Link
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"roles": [
{
"display": "Registrant",
"id": "REGISTRANT"
}
],
"end": "2027-07-03",
"start": "2025-10-03"
}
Schema of the response body
{
"required": [
"entity",
"product"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"product": {
"$ref": "#/components/schemas/ProductData"
},
"entity": {
"$ref": "#/components/schemas/EntityData"
},
"roles": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityRoleData"
}
},
"end": {
"type": "string",
"format": "date",
"example": "2027-07-03"
},
"start": {
"type": "string",
"format": "date",
"example": "2025-10-03"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
PATCH /api/products/entities/{id}¶
Partially Update Product-Entity Link
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"roles": [
{
"display": "Registrant",
"id": "REGISTRANT"
}
],
"end": "2027-07-03",
"start": "2025-10-03"
}
Schema of the request body
{
"required": [
"entity",
"product"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"product": {
"$ref": "#/components/schemas/ProductData"
},
"entity": {
"$ref": "#/components/schemas/EntityData"
},
"roles": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityRoleData"
}
},
"end": {
"type": "string",
"format": "date",
"example": "2027-07-03"
},
"start": {
"type": "string",
"format": "date",
"example": "2025-10-03"
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"roles": [
{
"display": "Registrant",
"id": "REGISTRANT"
}
],
"end": "2027-07-03",
"start": "2025-10-03"
}
Schema of the response body
{
"required": [
"entity",
"product"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"product": {
"$ref": "#/components/schemas/ProductData"
},
"entity": {
"$ref": "#/components/schemas/EntityData"
},
"roles": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityRoleData"
}
},
"end": {
"type": "string",
"format": "date",
"example": "2027-07-03"
},
"start": {
"type": "string",
"format": "date",
"example": "2025-10-03"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
GET /api/products/entities¶
Get all Product-Entity links
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
page |
query | integer | 0 | Yes | Zero-based page index (0..N) |
product |
query | integer | Yes | Filter links by product | |
size |
query | integer | 20 | Yes | The size of the page to be returned |
sort |
query | array | Yes | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Response 200 OK
{
"totalPages": 91,
"totalElements": 256,
"size": 112,
"content": [
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"roles": [
{
"display": "Registrant",
"id": "REGISTRANT"
}
],
"end": "2027-07-03",
"start": "2025-10-03"
}
],
"number": 56,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"pageable": {
"offset": 106,
"sort": null,
"unpaged": true,
"paged": true,
"pageSize": 146,
"pageNumber": 36
},
"numberOfElements": 236,
"first": true,
"last": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductEntityData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
POST /api/products/entities¶
Create new Product-Entity Link
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"roles": [
{
"display": "Registrant",
"id": "REGISTRANT"
}
],
"end": "2027-07-03",
"start": "2025-10-03"
}
Schema of the request body
{
"required": [
"entity",
"product"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"product": {
"$ref": "#/components/schemas/ProductData"
},
"entity": {
"$ref": "#/components/schemas/EntityData"
},
"roles": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityRoleData"
}
},
"end": {
"type": "string",
"format": "date",
"example": "2027-07-03"
},
"start": {
"type": "string",
"format": "date",
"example": "2025-10-03"
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"roles": [
{
"display": "Registrant",
"id": "REGISTRANT"
}
],
"end": "2027-07-03",
"start": "2025-10-03"
}
Schema of the response body
{
"required": [
"entity",
"product"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"product": {
"$ref": "#/components/schemas/ProductData"
},
"entity": {
"$ref": "#/components/schemas/EntityData"
},
"roles": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityRoleData"
}
},
"end": {
"type": "string",
"format": "date",
"example": "2027-07-03"
},
"start": {
"type": "string",
"format": "date",
"example": "2025-10-03"
}
}
}
Response 403 Forbidden
Response 400 Bad Request
Response 500 Internal Server Error
Study Milestones¶
GET /api/milestones/{id}¶
Get a Milestone
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"study": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
},
"activity": {
"id": 1,
"activity": "string",
"contractRef": "string",
"studyNumber": "string"
},
"name": "Contract Signature",
"plannedDate": "2022-04-13",
"completedDate": "2022-04-13",
"signedBy": null,
"status": "COMPLETED"
}
Schema of the response body
{
"required": [
"study"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"study": {
"$ref": "#/components/schemas/StudyData"
},
"activity": {
"$ref": "#/components/schemas/StudyNumberData"
},
"name": {
"type": "string",
"example": "Contract Signature"
},
"plannedDate": {
"type": "string",
"format": "date"
},
"completedDate": {
"type": "string",
"format": "date"
},
"signedBy": {
"$ref": "#/components/schemas/UserData"
},
"status": {
"type": "string",
"enum": [
"COMPLETED",
"OVERDUE",
"OVERDUE_LONG",
"PLANNED"
]
}
}
}
Response 403 Forbidden
{
"id": 1,
"study": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
},
"activity": {
"id": 1,
"activity": "string",
"contractRef": "string",
"studyNumber": "string"
},
"name": "Contract Signature",
"plannedDate": "2022-04-13",
"completedDate": "2022-04-13",
"signedBy": null,
"status": "COMPLETED"
}
Schema of the response body
{
"required": [
"study"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"study": {
"$ref": "#/components/schemas/StudyData"
},
"activity": {
"$ref": "#/components/schemas/StudyNumberData"
},
"name": {
"type": "string",
"example": "Contract Signature"
},
"plannedDate": {
"type": "string",
"format": "date"
},
"completedDate": {
"type": "string",
"format": "date"
},
"signedBy": {
"$ref": "#/components/schemas/UserData"
},
"status": {
"type": "string",
"enum": [
"COMPLETED",
"OVERDUE",
"OVERDUE_LONG",
"PLANNED"
]
}
}
}
PUT /api/milestones/{id}¶
Fully update a Milestone
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"study": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
},
"activity": {
"id": 1,
"activity": "string",
"contractRef": "string",
"studyNumber": "string"
},
"name": "Contract Signature",
"plannedDate": "2022-04-13",
"completedDate": "2022-04-13",
"signedBy": null,
"status": "COMPLETED"
}
Schema of the request body
{
"required": [
"study"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"study": {
"$ref": "#/components/schemas/StudyData"
},
"activity": {
"$ref": "#/components/schemas/StudyNumberData"
},
"name": {
"type": "string",
"example": "Contract Signature"
},
"plannedDate": {
"type": "string",
"format": "date"
},
"completedDate": {
"type": "string",
"format": "date"
},
"signedBy": {
"$ref": "#/components/schemas/UserData"
},
"status": {
"type": "string",
"enum": [
"COMPLETED",
"OVERDUE",
"OVERDUE_LONG",
"PLANNED"
]
}
}
}
Response 200 OK
{
"id": 1,
"study": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
},
"activity": {
"id": 1,
"activity": "string",
"contractRef": "string",
"studyNumber": "string"
},
"name": "Contract Signature",
"plannedDate": "2022-04-13",
"completedDate": "2022-04-13",
"signedBy": null,
"status": "COMPLETED"
}
Schema of the response body
{
"required": [
"study"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"study": {
"$ref": "#/components/schemas/StudyData"
},
"activity": {
"$ref": "#/components/schemas/StudyNumberData"
},
"name": {
"type": "string",
"example": "Contract Signature"
},
"plannedDate": {
"type": "string",
"format": "date"
},
"completedDate": {
"type": "string",
"format": "date"
},
"signedBy": {
"$ref": "#/components/schemas/UserData"
},
"status": {
"type": "string",
"enum": [
"COMPLETED",
"OVERDUE",
"OVERDUE_LONG",
"PLANNED"
]
}
}
}
Response 403 Forbidden
{
"id": 1,
"study": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
},
"activity": {
"id": 1,
"activity": "string",
"contractRef": "string",
"studyNumber": "string"
},
"name": "Contract Signature",
"plannedDate": "2022-04-13",
"completedDate": "2022-04-13",
"signedBy": null,
"status": "COMPLETED"
}
Schema of the response body
{
"required": [
"study"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"study": {
"$ref": "#/components/schemas/StudyData"
},
"activity": {
"$ref": "#/components/schemas/StudyNumberData"
},
"name": {
"type": "string",
"example": "Contract Signature"
},
"plannedDate": {
"type": "string",
"format": "date"
},
"completedDate": {
"type": "string",
"format": "date"
},
"signedBy": {
"$ref": "#/components/schemas/UserData"
},
"status": {
"type": "string",
"enum": [
"COMPLETED",
"OVERDUE",
"OVERDUE_LONG",
"PLANNED"
]
}
}
}
DELETE /api/milestones/{id}¶
Delete a Milestone
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
Response 403 Forbidden
PATCH /api/milestones/{id}¶
Partially update a Milestone
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
Schema of the request body
{
"type": "object",
"additionalProperties": {
"type": "object"
}
}
Response 200 OK
{
"id": 1,
"study": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
},
"activity": {
"id": 1,
"activity": "string",
"contractRef": "string",
"studyNumber": "string"
},
"name": "Contract Signature",
"plannedDate": "2022-04-13",
"completedDate": "2022-04-13",
"signedBy": null,
"status": "COMPLETED"
}
Schema of the response body
{
"required": [
"study"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"study": {
"$ref": "#/components/schemas/StudyData"
},
"activity": {
"$ref": "#/components/schemas/StudyNumberData"
},
"name": {
"type": "string",
"example": "Contract Signature"
},
"plannedDate": {
"type": "string",
"format": "date"
},
"completedDate": {
"type": "string",
"format": "date"
},
"signedBy": {
"$ref": "#/components/schemas/UserData"
},
"status": {
"type": "string",
"enum": [
"COMPLETED",
"OVERDUE",
"OVERDUE_LONG",
"PLANNED"
]
}
}
}
Response 403 Forbidden
{
"id": 1,
"study": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
},
"activity": {
"id": 1,
"activity": "string",
"contractRef": "string",
"studyNumber": "string"
},
"name": "Contract Signature",
"plannedDate": "2022-04-13",
"completedDate": "2022-04-13",
"signedBy": null,
"status": "COMPLETED"
}
Schema of the response body
{
"required": [
"study"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"study": {
"$ref": "#/components/schemas/StudyData"
},
"activity": {
"$ref": "#/components/schemas/StudyNumberData"
},
"name": {
"type": "string",
"example": "Contract Signature"
},
"plannedDate": {
"type": "string",
"format": "date"
},
"completedDate": {
"type": "string",
"format": "date"
},
"signedBy": {
"$ref": "#/components/schemas/UserData"
},
"status": {
"type": "string",
"enum": [
"COMPLETED",
"OVERDUE",
"OVERDUE_LONG",
"PLANNED"
]
}
}
}
GET /api/milestones¶
Get Milestones
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
page |
query | integer | 0 | Yes | Zero-based page index (0..N) |
size |
query | integer | 20 | Yes | The size of the page to be returned |
sort |
query | array | Yes | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | |
study |
query | integer | Yes | Filter milestones by study |
Response 200 OK
{
"totalPages": 170,
"totalElements": 25,
"size": 209,
"content": [
{
"id": 1,
"study": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
},
"activity": {
"id": 1,
"activity": "string",
"contractRef": "string",
"studyNumber": "string"
},
"name": "Contract Signature",
"plannedDate": "2022-04-13",
"completedDate": "2022-04-13",
"signedBy": null,
"status": "COMPLETED"
}
],
"number": 127,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"pageable": {
"offset": 134,
"sort": null,
"unpaged": true,
"paged": true,
"pageSize": 13,
"pageNumber": 264
},
"numberOfElements": 262,
"first": true,
"last": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StudyActivityData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
{
"totalPages": 151,
"totalElements": 118,
"size": 239,
"content": [
{
"id": 1,
"study": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
},
"activity": {
"id": 1,
"activity": "string",
"contractRef": "string",
"studyNumber": "string"
},
"name": "Contract Signature",
"plannedDate": "2022-04-13",
"completedDate": "2022-04-13",
"signedBy": null,
"status": "COMPLETED"
}
],
"number": 222,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"pageable": {
"offset": 66,
"sort": null,
"unpaged": true,
"paged": true,
"pageSize": 183,
"pageNumber": 124
},
"numberOfElements": 75,
"first": true,
"last": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StudyActivityData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
POST /api/milestones¶
Create a Milestone
Request body
{
"id": 1,
"study": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
},
"activity": {
"id": 1,
"activity": "string",
"contractRef": "string",
"studyNumber": "string"
},
"name": "Contract Signature",
"plannedDate": "2022-04-13",
"completedDate": "2022-04-13",
"signedBy": null,
"status": "COMPLETED"
}
Schema of the request body
{
"required": [
"study"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"study": {
"$ref": "#/components/schemas/StudyData"
},
"activity": {
"$ref": "#/components/schemas/StudyNumberData"
},
"name": {
"type": "string",
"example": "Contract Signature"
},
"plannedDate": {
"type": "string",
"format": "date"
},
"completedDate": {
"type": "string",
"format": "date"
},
"signedBy": {
"$ref": "#/components/schemas/UserData"
},
"status": {
"type": "string",
"enum": [
"COMPLETED",
"OVERDUE",
"OVERDUE_LONG",
"PLANNED"
]
}
}
}
Response 200 OK
{
"id": 1,
"study": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
},
"activity": {
"id": 1,
"activity": "string",
"contractRef": "string",
"studyNumber": "string"
},
"name": "Contract Signature",
"plannedDate": "2022-04-13",
"completedDate": "2022-04-13",
"signedBy": null,
"status": "COMPLETED"
}
Schema of the response body
{
"required": [
"study"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"study": {
"$ref": "#/components/schemas/StudyData"
},
"activity": {
"$ref": "#/components/schemas/StudyNumberData"
},
"name": {
"type": "string",
"example": "Contract Signature"
},
"plannedDate": {
"type": "string",
"format": "date"
},
"completedDate": {
"type": "string",
"format": "date"
},
"signedBy": {
"$ref": "#/components/schemas/UserData"
},
"status": {
"type": "string",
"enum": [
"COMPLETED",
"OVERDUE",
"OVERDUE_LONG",
"PLANNED"
]
}
}
}
Response 403 Forbidden
{
"id": 1,
"study": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "001-Cat Z-Analysis-Int",
"status": "ACTIVE",
"start": "2022-04-13",
"end": "2022-04-13",
"purpose": "VI",
"archived": true,
"testingLaboratoryEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
},
"activity": {
"id": 1,
"activity": "string",
"contractRef": "string",
"studyNumber": "string"
},
"name": "Contract Signature",
"plannedDate": "2022-04-13",
"completedDate": "2022-04-13",
"signedBy": null,
"status": "COMPLETED"
}
Schema of the response body
{
"required": [
"study"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"study": {
"$ref": "#/components/schemas/StudyData"
},
"activity": {
"$ref": "#/components/schemas/StudyNumberData"
},
"name": {
"type": "string",
"example": "Contract Signature"
},
"plannedDate": {
"type": "string",
"format": "date"
},
"completedDate": {
"type": "string",
"format": "date"
},
"signedBy": {
"$ref": "#/components/schemas/UserData"
},
"status": {
"type": "string",
"enum": [
"COMPLETED",
"OVERDUE",
"OVERDUE_LONG",
"PLANNED"
]
}
}
}
Formulations¶
GET /api/formulations/{id}¶
Get a Formulation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"product": {
"$ref": "#/components/schemas/ProductData"
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"identifier": {
"type": "string"
},
"remarks": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FormulationTypeData"
}
}
}
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
PUT /api/formulations/{id}¶
Full Update a Formulation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"product": {
"$ref": "#/components/schemas/ProductData"
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"identifier": {
"type": "string"
},
"remarks": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FormulationTypeData"
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"product": {
"$ref": "#/components/schemas/ProductData"
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"identifier": {
"type": "string"
},
"remarks": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FormulationTypeData"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/formulations/{id}¶
Delete a Formulation
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/formulations/{id}¶
Partially Update a Formulation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
Schema of the request body
{
"type": "object",
"additionalProperties": {
"type": "object"
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"product": {
"$ref": "#/components/schemas/ProductData"
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"identifier": {
"type": "string"
},
"remarks": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FormulationTypeData"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/formulations/versions/{id}¶
Get a Formulation Version
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"composition": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
},
"formulation": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": null,
"constituent": null,
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
},
"number": 164,
"start": "2022-04-13",
"end": "2022-04-13",
"remarks": "string",
"current": true
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"composition": {
"$ref": "#/components/schemas/CompositionData"
},
"formulation": {
"$ref": "#/components/schemas/FormulationData"
},
"number": {
"type": "integer",
"format": "int32"
},
"start": {
"type": "string",
"format": "date"
},
"end": {
"type": "string",
"format": "date"
},
"remarks": {
"type": "string"
},
"current": {
"type": "boolean"
}
}
}
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
PUT /api/formulations/versions/{id}¶
Full Update a Formulation Version
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"composition": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
},
"formulation": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": null,
"constituent": null,
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
},
"number": 270,
"start": "2022-04-13",
"end": "2022-04-13",
"remarks": "string",
"current": true
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"composition": {
"$ref": "#/components/schemas/CompositionData"
},
"formulation": {
"$ref": "#/components/schemas/FormulationData"
},
"number": {
"type": "integer",
"format": "int32"
},
"start": {
"type": "string",
"format": "date"
},
"end": {
"type": "string",
"format": "date"
},
"remarks": {
"type": "string"
},
"current": {
"type": "boolean"
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"composition": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
},
"formulation": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": null,
"constituent": null,
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
},
"number": 114,
"start": "2022-04-13",
"end": "2022-04-13",
"remarks": "string",
"current": true
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"composition": {
"$ref": "#/components/schemas/CompositionData"
},
"formulation": {
"$ref": "#/components/schemas/FormulationData"
},
"number": {
"type": "integer",
"format": "int32"
},
"start": {
"type": "string",
"format": "date"
},
"end": {
"type": "string",
"format": "date"
},
"remarks": {
"type": "string"
},
"current": {
"type": "boolean"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/formulations/versions/{id}¶
Delete a Formulation Version
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 204 No Content
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
PATCH /api/formulations/versions/{id}¶
Partially Update a Formulation Version
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
Schema of the request body
{
"type": "object",
"additionalProperties": {
"type": "object"
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"composition": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
},
"formulation": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": null,
"constituent": null,
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
},
"number": 209,
"start": "2022-04-13",
"end": "2022-04-13",
"remarks": "string",
"current": true
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"composition": {
"$ref": "#/components/schemas/CompositionData"
},
"formulation": {
"$ref": "#/components/schemas/FormulationData"
},
"number": {
"type": "integer",
"format": "int32"
},
"start": {
"type": "string",
"format": "date"
},
"end": {
"type": "string",
"format": "date"
},
"remarks": {
"type": "string"
},
"current": {
"type": "boolean"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/formulations¶
Get Formulations
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
constituent |
query | integer | Yes | ||
product |
query | integer | Yes |
Response 200 OK
[
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/FormulationData"
}
}
POST /api/formulations¶
Create a Formulation
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"product": {
"$ref": "#/components/schemas/ProductData"
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"identifier": {
"type": "string"
},
"remarks": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FormulationTypeData"
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"product": {
"$ref": "#/components/schemas/ProductData"
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"identifier": {
"type": "string"
},
"remarks": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FormulationTypeData"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/formulations/versions¶
Get Formulation Versions
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
constituent |
query | integer | Yes | ||
formulation |
query | integer | Yes | ||
product |
query | integer | Yes |
Response 200 OK
[
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"composition": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
},
"formulation": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": null,
"constituent": null,
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
},
"number": 50,
"start": "2022-04-13",
"end": "2022-04-13",
"remarks": "string",
"current": true
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/CompositeVersionData"
}
}
POST /api/formulations/versions¶
Create a Formulation Version
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"composition": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
},
"formulation": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": null,
"constituent": null,
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
},
"number": 34,
"start": "2022-04-13",
"end": "2022-04-13",
"remarks": "string",
"current": true
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"composition": {
"$ref": "#/components/schemas/CompositionData"
},
"formulation": {
"$ref": "#/components/schemas/FormulationData"
},
"number": {
"type": "integer",
"format": "int32"
},
"start": {
"type": "string",
"format": "date"
},
"end": {
"type": "string",
"format": "date"
},
"remarks": {
"type": "string"
},
"current": {
"type": "boolean"
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"composition": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
},
"formulation": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": null,
"constituent": null,
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
},
"number": 34,
"start": "2022-04-13",
"end": "2022-04-13",
"remarks": "string",
"current": true
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"composition": {
"$ref": "#/components/schemas/CompositionData"
},
"formulation": {
"$ref": "#/components/schemas/FormulationData"
},
"number": {
"type": "integer",
"format": "int32"
},
"start": {
"type": "string",
"format": "date"
},
"end": {
"type": "string",
"format": "date"
},
"remarks": {
"type": "string"
},
"current": {
"type": "boolean"
}
}
}
Response 400 Bad Request
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 200 OK
{
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": {
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": null,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"createdDate": "2022-04-13T15:42:05.901Z"
},
"createdBy": null,
"createdDate": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Reports"
},
"parent": {
"$ref": "#/components/schemas/FolderData"
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"createdDate": {
"type": "string",
"format": "date-time"
}
}
}
Response 403 Forbidden
Response 404 Not Found
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,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"createdDate": "2022-04-13T15:42:05.901Z"
},
"createdBy": null,
"createdDate": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Reports"
},
"parent": {
"$ref": "#/components/schemas/FolderData"
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"createdDate": {
"type": "string",
"format": "date-time"
}
}
}
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": {
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": null,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"createdDate": "2022-04-13T15:42:05.901Z"
},
"createdBy": null,
"createdDate": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Reports"
},
"parent": {
"$ref": "#/components/schemas/FolderData"
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"createdDate": {
"type": "string",
"format": "date-time"
}
}
}
Response 400 Bad Request
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 403 Forbidden
Response 500 Internal Server Error
PATCH /api/folders/{id}¶
Partially Update a Folder
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
Schema of the request body
{
"type": "object",
"additionalProperties": {
"type": "object"
}
}
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": {
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": null,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"createdDate": "2022-04-13T15:42:05.901Z"
},
"createdBy": null,
"createdDate": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Reports"
},
"parent": {
"$ref": "#/components/schemas/FolderData"
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"createdDate": {
"type": "string",
"format": "date-time"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/folders¶
Get all Folders
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
folder |
query | integer | Yes | Filter folders by parent folder (not including nested folders) | |
page |
query | integer | 0 | Yes | Zero-based page index (0..N) |
size |
query | integer | 20 | Yes | The size of the page to be returned |
sort |
query | array | Yes | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Response 200 OK
{
"totalPages": 90,
"totalElements": 186,
"size": 21,
"content": [
{
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": null,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"createdDate": "2022-04-13T15:42:05.901Z"
}
],
"number": 191,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"pageable": {
"offset": 177,
"sort": null,
"unpaged": true,
"paged": true,
"pageSize": 285,
"pageNumber": 145
},
"numberOfElements": 156,
"first": true,
"last": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FolderData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"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,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"createdDate": "2022-04-13T15:42:05.901Z"
},
"createdBy": null,
"createdDate": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Reports"
},
"parent": {
"$ref": "#/components/schemas/FolderData"
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"createdDate": {
"type": "string",
"format": "date-time"
}
}
}
Response 200 OK
{
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": {
"id": 1,
"partitionId": 100,
"name": "Reports",
"parent": null,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"createdDate": "2022-04-13T15:42:05.901Z"
},
"createdBy": null,
"createdDate": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Reports"
},
"parent": {
"$ref": "#/components/schemas/FolderData"
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"createdDate": {
"type": "string",
"format": "date-time"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
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,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
Schema of the response body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Penman Consulting"
},
"companyNo": {
"type": "string"
},
"vatNo": {
"type": "string"
},
"dunnNo": {
"type": "string"
},
"utr": {
"type": "string"
},
"invoiceRef": {
"type": "string",
"example": "PENMAN_212REF"
},
"reachUuid": {
"pattern": "^\\s*(([Ee][Cc][Hh][Aa]-)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})?\\s*$",
"type": "string",
"description": "REACH UUID of the legal entity (not the IUCLID UUID). A UUID, optionally prefixed with 'ECHA-'",
"example": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b"
},
"archived": {
"type": "boolean",
"example": false
}
}
}
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,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
Schema of the request body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Penman Consulting"
},
"companyNo": {
"type": "string"
},
"vatNo": {
"type": "string"
},
"dunnNo": {
"type": "string"
},
"utr": {
"type": "string"
},
"invoiceRef": {
"type": "string",
"example": "PENMAN_212REF"
},
"reachUuid": {
"pattern": "^\\s*(([Ee][Cc][Hh][Aa]-)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})?\\s*$",
"type": "string",
"description": "REACH UUID of the legal entity (not the IUCLID UUID). A UUID, optionally prefixed with 'ECHA-'",
"example": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b"
},
"archived": {
"type": "boolean",
"example": false
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
Schema of the response body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Penman Consulting"
},
"companyNo": {
"type": "string"
},
"vatNo": {
"type": "string"
},
"dunnNo": {
"type": "string"
},
"utr": {
"type": "string"
},
"invoiceRef": {
"type": "string",
"example": "PENMAN_212REF"
},
"reachUuid": {
"pattern": "^\\s*(([Ee][Cc][Hh][Aa]-)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})?\\s*$",
"type": "string",
"description": "REACH UUID of the legal entity (not the IUCLID UUID). A UUID, optionally prefixed with 'ECHA-'",
"example": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b"
},
"archived": {
"type": "boolean",
"example": false
}
}
}
Response 400 Bad Request
Response 403 Forbidden
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,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
Schema of the request body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Penman Consulting"
},
"companyNo": {
"type": "string"
},
"vatNo": {
"type": "string"
},
"dunnNo": {
"type": "string"
},
"utr": {
"type": "string"
},
"invoiceRef": {
"type": "string",
"example": "PENMAN_212REF"
},
"reachUuid": {
"pattern": "^\\s*(([Ee][Cc][Hh][Aa]-)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})?\\s*$",
"type": "string",
"description": "REACH UUID of the legal entity (not the IUCLID UUID). A UUID, optionally prefixed with 'ECHA-'",
"example": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b"
},
"archived": {
"type": "boolean",
"example": false
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
Schema of the response body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Penman Consulting"
},
"companyNo": {
"type": "string"
},
"vatNo": {
"type": "string"
},
"dunnNo": {
"type": "string"
},
"utr": {
"type": "string"
},
"invoiceRef": {
"type": "string",
"example": "PENMAN_212REF"
},
"reachUuid": {
"pattern": "^\\s*(([Ee][Cc][Hh][Aa]-)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})?\\s*$",
"type": "string",
"description": "REACH UUID of the legal entity (not the IUCLID UUID). A UUID, optionally prefixed with 'ECHA-'",
"example": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b"
},
"archived": {
"type": "boolean",
"example": false
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
GET /api/entities¶
Get all Entities
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
constituent |
query | integer | Yes | Filter entities by constituent | |
contact |
query | integer | Yes | Filter entities by contact | |
page |
query | integer | 0 | Yes | Zero-based page index (0..N) |
partitionId |
query | integer | Yes | Only records in this partition. Omit it for all partitions. Applies to the reachUuid filter and to the unfiltered list; a product, constituent or contact is of one partition already | |
product |
query | integer | Yes | Filter entities by product | |
reachUuid |
query | string | Yes | Filter entities by REACH UUID (case-insensitive exact match) | |
size |
query | integer | 20 | Yes | The size of the page to be returned |
sort |
query | array | Yes | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Response 200 OK
{
"totalPages": 256,
"totalElements": 155,
"size": 81,
"content": [
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
],
"number": 237,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"pageable": {
"offset": 211,
"sort": null,
"unpaged": true,
"paged": true,
"pageSize": 166,
"pageNumber": 78
},
"numberOfElements": 104,
"first": true,
"last": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
POST /api/entities¶
Create an Entity
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
Schema of the request body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Penman Consulting"
},
"companyNo": {
"type": "string"
},
"vatNo": {
"type": "string"
},
"dunnNo": {
"type": "string"
},
"utr": {
"type": "string"
},
"invoiceRef": {
"type": "string",
"example": "PENMAN_212REF"
},
"reachUuid": {
"pattern": "^\\s*(([Ee][Cc][Hh][Aa]-)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})?\\s*$",
"type": "string",
"description": "REACH UUID of the legal entity (not the IUCLID UUID). A UUID, optionally prefixed with 'ECHA-'",
"example": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b"
},
"archived": {
"type": "boolean",
"example": false
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
}
Schema of the response body
{
"required": [
"name",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Penman Consulting"
},
"companyNo": {
"type": "string"
},
"vatNo": {
"type": "string"
},
"dunnNo": {
"type": "string"
},
"utr": {
"type": "string"
},
"invoiceRef": {
"type": "string",
"example": "PENMAN_212REF"
},
"reachUuid": {
"pattern": "^\\s*(([Ee][Cc][Hh][Aa]-)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})?\\s*$",
"type": "string",
"description": "REACH UUID of the legal entity (not the IUCLID UUID). A UUID, optionally prefixed with 'ECHA-'",
"example": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b"
},
"archived": {
"type": "boolean",
"example": false
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 500 Internal Server Error
Documents¶
GET /api/documents/{id}¶
Get a Document
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "2025-31-01 Benzene CSR",
"type": "CSR",
"documentCreationDate": "2027-07-01",
"invoiceDate": "2025-07-11",
"sentViaEmail": false,
"toEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"fromEntity": null,
"invoiceType": "Commercial",
"invoiceNumber": "1234",
"currency": "EUR",
"subTotal": 100.0,
"total": 150.0,
"outstandingAmount": 10.12,
"paymentReceivedDate": "2025-07-11",
"paymentApproved": false,
"paymentApprovedDate": "2025-07-11",
"paymentApprovedBy": null,
"paymentSent": false,
"paymentSentDate": "2025-07-11",
"paymentSentBy": null,
"legislation": "EU_REACH",
"vat": 10.0,
"purchaseOrder": "PO123",
"accountantReference": "SI/23/25",
"contractType": "LETTER_OF_ACCESS",
"contractDate": "2026-10-01",
"tonnageBand": "BAND_1",
"constituents": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
}
],
"products": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
}
],
"entities": null,
"cost": 1500.0,
"fee": 150.0,
"paymentReceived": true
}
Schema of the response body
{
"required": [
"documentCreationDate",
"name",
"partitionId",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "2025-31-01 Benzene CSR"
},
"type": {
"type": "string",
"example": "CSR",
"enum": [
"DOCUMENT",
"INVOICE",
"ANALYTICAL_REPORT",
"CJD",
"CONTRACT",
"CWA",
"CSR",
"DU",
"DRC_CONSTITUENT",
"DRC",
"GENDOC",
"IUCLID",
"MEET",
"REPORT",
"RSC",
"SAFETY",
"EMAIL",
"GENERIC_EMAIL",
"INTERNAL_EMAIL"
]
},
"documentCreationDate": {
"type": "string",
"format": "date",
"example": "2027-07-01"
},
"invoiceDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"sentViaEmail": {
"type": "boolean",
"example": false
},
"toEntity": {
"$ref": "#/components/schemas/EntityData"
},
"fromEntity": {
"$ref": "#/components/schemas/EntityData"
},
"invoiceType": {
"type": "string",
"example": "Commercial",
"enum": [
"COMMERCIAL",
"OPERATIONAL",
"TECHNICAL",
"TESTING",
"SETTLEMENT",
"LETTER_OF_ACCESS"
]
},
"invoiceNumber": {
"type": "string",
"example": "1234"
},
"currency": {
"type": "string",
"description": "An invoice's currency code, or a contract's ISO 4217 currency of cost and fee",
"example": "EUR"
},
"subTotal": {
"type": "number",
"example": 100.0
},
"total": {
"type": "number",
"example": 150.0
},
"outstandingAmount": {
"type": "number"
},
"paymentReceivedDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"paymentApproved": {
"type": "boolean",
"example": false
},
"paymentApprovedDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"paymentApprovedBy": {
"$ref": "#/components/schemas/UserData"
},
"paymentSent": {
"type": "boolean",
"example": false
},
"paymentSentDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"paymentSentBy": {
"$ref": "#/components/schemas/UserData"
},
"legislation": {
"type": "string",
"description": "An invoice's or a contract's legislation",
"example": "EU_REACH",
"enum": [
"AUSTRALIA_AICIS",
"BIOCIDES",
"BRAZIL_REACH",
"CANADA_CEPA",
"CHILE_REACH",
"CHINA",
"COLOMBIA_REACH",
"EU_CLP",
"EU_FSA",
"EU_DWD",
"EU_FCM",
"EU_PPP",
"EU_REACH",
"EU_TSR",
"EURASIA_REACH",
"INDIA_REACH",
"IRIS",
"JAPAN_CSCL",
"K_REACH",
"NZ_HSNO",
"OECD_HPV",
"OSHA",
"OSPAR",
"PHILIPPINE_APMPIN",
"SARA",
"SWISS_REACH",
"TAIWAN_REACH",
"TURKEY_REACH",
"UK_REACH",
"UKRAINE_REACH",
"US_TSCA",
"OTHER",
"NO_REGULATION"
]
},
"vat": {
"type": "number",
"example": 10.0
},
"purchaseOrder": {
"type": "string",
"example": "PO123"
},
"accountantReference": {
"type": "string",
"example": "SI/23/25"
},
"contractType": {
"type": "string",
"description": "Contract documents only",
"example": "LETTER_OF_ACCESS",
"enum": [
"CLIENT",
"COMMERCIAL",
"CONSORTIUM",
"CONTRACTOR",
"CONTRACTOR_ADDENDUM",
"CONFIDENTIALITY_AGREEMENT",
"DECLARATION_OF_REACH_CONFORMITY",
"LETTER_OF_ACCESS",
"OR_APPOINTMENT_LETTER",
"SIEF",
"SUPPLIER",
"OTHER"
]
},
"contractDate": {
"type": "string",
"description": "Contract documents only",
"format": "date",
"example": "2026-10-01"
},
"tonnageBand": {
"type": "string",
"description": "Contract documents only",
"example": "BAND_1",
"enum": [
"BAND_1",
"BAND_2",
"BAND_3",
"BAND_4",
"BAND_5",
"BAND_6",
"BAND_7",
"BAND_8",
"BAND_9",
"BAND_K_1",
"BAND_K_2",
"BAND_K_3",
"BAND_K_4",
"BAND_K_5",
"BAND_K_6",
"BAND_K_7",
"BAND_K_8",
"BAND_K_9",
"BAND_K_10",
"BAND_K_11",
"BAND_K_12",
"BAND_K_13",
"BAND_K_14",
"BAND_K_15",
"BAND_K_16",
"BAND_K_17",
"BAND_K_18",
"BAND_K_19",
"BAND_K_20",
"CEASE_OF_MANUFACTURE"
]
},
"constituents": {
"type": "array",
"description": "Contract documents only: the linked constituents, archived ones included ('archived' says which). Replaces the existing links when sent; only each constituent's id is read",
"items": {
"$ref": "#/components/schemas/ConstituentData"
}
},
"products": {
"type": "array",
"description": "Contract documents only: the linked products, archived ones included ('archived' says which). Replaces the existing links when sent; only each product's id is read",
"items": {
"$ref": "#/components/schemas/ProductData"
}
},
"entities": {
"type": "array",
"description": "Contract documents only: the linked entities, archived ones included ('archived' says which). Replaces the existing links when sent; only each entity's id is read",
"items": {
"$ref": "#/components/schemas/EntityData"
}
},
"cost": {
"type": "number",
"description": "Contract documents only: contracted cost. For LETTER_OF_ACCESS contracts this is defaulted from the substance's Letter of Access cost, as the contract form does: when constituents, legislation or tonnageBand are sent without cost, fee or currency, and the contract then names exactly one constituent, a legislation and a tonnage band with a cost in force on the contract date. A sent value is kept as is.",
"example": 1500.0
},
"fee": {
"type": "number",
"description": "Contract documents only: administration fee. For LETTER_OF_ACCESS contracts this is defaulted from the substance's Letter of Access cost, as the contract form does: when constituents, legislation or tonnageBand are sent without cost, fee or currency, and the contract then names exactly one constituent, a legislation and a tonnage band with a cost in force on the contract date. A sent value is kept as is.",
"example": 150.0
},
"paymentReceived": {
"type": "boolean",
"deprecated": true
}
}
}
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
PUT /api/documents/{id}¶
Update a Document
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "2025-31-01 Benzene CSR",
"type": "CSR",
"documentCreationDate": "2027-07-01",
"invoiceDate": "2025-07-11",
"sentViaEmail": false,
"toEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"fromEntity": null,
"invoiceType": "Commercial",
"invoiceNumber": "1234",
"currency": "EUR",
"subTotal": 100.0,
"total": 150.0,
"outstandingAmount": 10.12,
"paymentReceivedDate": "2025-07-11",
"paymentApproved": false,
"paymentApprovedDate": "2025-07-11",
"paymentApprovedBy": null,
"paymentSent": false,
"paymentSentDate": "2025-07-11",
"paymentSentBy": null,
"legislation": "EU_REACH",
"vat": 10.0,
"purchaseOrder": "PO123",
"accountantReference": "SI/23/25",
"contractType": "LETTER_OF_ACCESS",
"contractDate": "2026-10-01",
"tonnageBand": "BAND_1",
"constituents": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
}
],
"products": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
}
],
"entities": null,
"cost": 1500.0,
"fee": 150.0,
"paymentReceived": true
}
Schema of the request body
{
"required": [
"documentCreationDate",
"name",
"partitionId",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "2025-31-01 Benzene CSR"
},
"type": {
"type": "string",
"example": "CSR",
"enum": [
"DOCUMENT",
"INVOICE",
"ANALYTICAL_REPORT",
"CJD",
"CONTRACT",
"CWA",
"CSR",
"DU",
"DRC_CONSTITUENT",
"DRC",
"GENDOC",
"IUCLID",
"MEET",
"REPORT",
"RSC",
"SAFETY",
"EMAIL",
"GENERIC_EMAIL",
"INTERNAL_EMAIL"
]
},
"documentCreationDate": {
"type": "string",
"format": "date",
"example": "2027-07-01"
},
"invoiceDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"sentViaEmail": {
"type": "boolean",
"example": false
},
"toEntity": {
"$ref": "#/components/schemas/EntityData"
},
"fromEntity": {
"$ref": "#/components/schemas/EntityData"
},
"invoiceType": {
"type": "string",
"example": "Commercial",
"enum": [
"COMMERCIAL",
"OPERATIONAL",
"TECHNICAL",
"TESTING",
"SETTLEMENT",
"LETTER_OF_ACCESS"
]
},
"invoiceNumber": {
"type": "string",
"example": "1234"
},
"currency": {
"type": "string",
"description": "An invoice's currency code, or a contract's ISO 4217 currency of cost and fee",
"example": "EUR"
},
"subTotal": {
"type": "number",
"example": 100.0
},
"total": {
"type": "number",
"example": 150.0
},
"outstandingAmount": {
"type": "number"
},
"paymentReceivedDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"paymentApproved": {
"type": "boolean",
"example": false
},
"paymentApprovedDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"paymentApprovedBy": {
"$ref": "#/components/schemas/UserData"
},
"paymentSent": {
"type": "boolean",
"example": false
},
"paymentSentDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"paymentSentBy": {
"$ref": "#/components/schemas/UserData"
},
"legislation": {
"type": "string",
"description": "An invoice's or a contract's legislation",
"example": "EU_REACH",
"enum": [
"AUSTRALIA_AICIS",
"BIOCIDES",
"BRAZIL_REACH",
"CANADA_CEPA",
"CHILE_REACH",
"CHINA",
"COLOMBIA_REACH",
"EU_CLP",
"EU_FSA",
"EU_DWD",
"EU_FCM",
"EU_PPP",
"EU_REACH",
"EU_TSR",
"EURASIA_REACH",
"INDIA_REACH",
"IRIS",
"JAPAN_CSCL",
"K_REACH",
"NZ_HSNO",
"OECD_HPV",
"OSHA",
"OSPAR",
"PHILIPPINE_APMPIN",
"SARA",
"SWISS_REACH",
"TAIWAN_REACH",
"TURKEY_REACH",
"UK_REACH",
"UKRAINE_REACH",
"US_TSCA",
"OTHER",
"NO_REGULATION"
]
},
"vat": {
"type": "number",
"example": 10.0
},
"purchaseOrder": {
"type": "string",
"example": "PO123"
},
"accountantReference": {
"type": "string",
"example": "SI/23/25"
},
"contractType": {
"type": "string",
"description": "Contract documents only",
"example": "LETTER_OF_ACCESS",
"enum": [
"CLIENT",
"COMMERCIAL",
"CONSORTIUM",
"CONTRACTOR",
"CONTRACTOR_ADDENDUM",
"CONFIDENTIALITY_AGREEMENT",
"DECLARATION_OF_REACH_CONFORMITY",
"LETTER_OF_ACCESS",
"OR_APPOINTMENT_LETTER",
"SIEF",
"SUPPLIER",
"OTHER"
]
},
"contractDate": {
"type": "string",
"description": "Contract documents only",
"format": "date",
"example": "2026-10-01"
},
"tonnageBand": {
"type": "string",
"description": "Contract documents only",
"example": "BAND_1",
"enum": [
"BAND_1",
"BAND_2",
"BAND_3",
"BAND_4",
"BAND_5",
"BAND_6",
"BAND_7",
"BAND_8",
"BAND_9",
"BAND_K_1",
"BAND_K_2",
"BAND_K_3",
"BAND_K_4",
"BAND_K_5",
"BAND_K_6",
"BAND_K_7",
"BAND_K_8",
"BAND_K_9",
"BAND_K_10",
"BAND_K_11",
"BAND_K_12",
"BAND_K_13",
"BAND_K_14",
"BAND_K_15",
"BAND_K_16",
"BAND_K_17",
"BAND_K_18",
"BAND_K_19",
"BAND_K_20",
"CEASE_OF_MANUFACTURE"
]
},
"constituents": {
"type": "array",
"description": "Contract documents only: the linked constituents, archived ones included ('archived' says which). Replaces the existing links when sent; only each constituent's id is read",
"items": {
"$ref": "#/components/schemas/ConstituentData"
}
},
"products": {
"type": "array",
"description": "Contract documents only: the linked products, archived ones included ('archived' says which). Replaces the existing links when sent; only each product's id is read",
"items": {
"$ref": "#/components/schemas/ProductData"
}
},
"entities": {
"type": "array",
"description": "Contract documents only: the linked entities, archived ones included ('archived' says which). Replaces the existing links when sent; only each entity's id is read",
"items": {
"$ref": "#/components/schemas/EntityData"
}
},
"cost": {
"type": "number",
"description": "Contract documents only: contracted cost. For LETTER_OF_ACCESS contracts this is defaulted from the substance's Letter of Access cost, as the contract form does: when constituents, legislation or tonnageBand are sent without cost, fee or currency, and the contract then names exactly one constituent, a legislation and a tonnage band with a cost in force on the contract date. A sent value is kept as is.",
"example": 1500.0
},
"fee": {
"type": "number",
"description": "Contract documents only: administration fee. For LETTER_OF_ACCESS contracts this is defaulted from the substance's Letter of Access cost, as the contract form does: when constituents, legislation or tonnageBand are sent without cost, fee or currency, and the contract then names exactly one constituent, a legislation and a tonnage band with a cost in force on the contract date. A sent value is kept as is.",
"example": 150.0
},
"paymentReceived": {
"type": "boolean",
"deprecated": true
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "2025-31-01 Benzene CSR",
"type": "CSR",
"documentCreationDate": "2027-07-01",
"invoiceDate": "2025-07-11",
"sentViaEmail": false,
"toEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"fromEntity": null,
"invoiceType": "Commercial",
"invoiceNumber": "1234",
"currency": "EUR",
"subTotal": 100.0,
"total": 150.0,
"outstandingAmount": 10.12,
"paymentReceivedDate": "2025-07-11",
"paymentApproved": false,
"paymentApprovedDate": "2025-07-11",
"paymentApprovedBy": null,
"paymentSent": false,
"paymentSentDate": "2025-07-11",
"paymentSentBy": null,
"legislation": "EU_REACH",
"vat": 10.0,
"purchaseOrder": "PO123",
"accountantReference": "SI/23/25",
"contractType": "LETTER_OF_ACCESS",
"contractDate": "2026-10-01",
"tonnageBand": "BAND_1",
"constituents": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
}
],
"products": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
}
],
"entities": null,
"cost": 1500.0,
"fee": 150.0,
"paymentReceived": true
}
Schema of the response body
{
"required": [
"documentCreationDate",
"name",
"partitionId",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "2025-31-01 Benzene CSR"
},
"type": {
"type": "string",
"example": "CSR",
"enum": [
"DOCUMENT",
"INVOICE",
"ANALYTICAL_REPORT",
"CJD",
"CONTRACT",
"CWA",
"CSR",
"DU",
"DRC_CONSTITUENT",
"DRC",
"GENDOC",
"IUCLID",
"MEET",
"REPORT",
"RSC",
"SAFETY",
"EMAIL",
"GENERIC_EMAIL",
"INTERNAL_EMAIL"
]
},
"documentCreationDate": {
"type": "string",
"format": "date",
"example": "2027-07-01"
},
"invoiceDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"sentViaEmail": {
"type": "boolean",
"example": false
},
"toEntity": {
"$ref": "#/components/schemas/EntityData"
},
"fromEntity": {
"$ref": "#/components/schemas/EntityData"
},
"invoiceType": {
"type": "string",
"example": "Commercial",
"enum": [
"COMMERCIAL",
"OPERATIONAL",
"TECHNICAL",
"TESTING",
"SETTLEMENT",
"LETTER_OF_ACCESS"
]
},
"invoiceNumber": {
"type": "string",
"example": "1234"
},
"currency": {
"type": "string",
"description": "An invoice's currency code, or a contract's ISO 4217 currency of cost and fee",
"example": "EUR"
},
"subTotal": {
"type": "number",
"example": 100.0
},
"total": {
"type": "number",
"example": 150.0
},
"outstandingAmount": {
"type": "number"
},
"paymentReceivedDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"paymentApproved": {
"type": "boolean",
"example": false
},
"paymentApprovedDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"paymentApprovedBy": {
"$ref": "#/components/schemas/UserData"
},
"paymentSent": {
"type": "boolean",
"example": false
},
"paymentSentDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"paymentSentBy": {
"$ref": "#/components/schemas/UserData"
},
"legislation": {
"type": "string",
"description": "An invoice's or a contract's legislation",
"example": "EU_REACH",
"enum": [
"AUSTRALIA_AICIS",
"BIOCIDES",
"BRAZIL_REACH",
"CANADA_CEPA",
"CHILE_REACH",
"CHINA",
"COLOMBIA_REACH",
"EU_CLP",
"EU_FSA",
"EU_DWD",
"EU_FCM",
"EU_PPP",
"EU_REACH",
"EU_TSR",
"EURASIA_REACH",
"INDIA_REACH",
"IRIS",
"JAPAN_CSCL",
"K_REACH",
"NZ_HSNO",
"OECD_HPV",
"OSHA",
"OSPAR",
"PHILIPPINE_APMPIN",
"SARA",
"SWISS_REACH",
"TAIWAN_REACH",
"TURKEY_REACH",
"UK_REACH",
"UKRAINE_REACH",
"US_TSCA",
"OTHER",
"NO_REGULATION"
]
},
"vat": {
"type": "number",
"example": 10.0
},
"purchaseOrder": {
"type": "string",
"example": "PO123"
},
"accountantReference": {
"type": "string",
"example": "SI/23/25"
},
"contractType": {
"type": "string",
"description": "Contract documents only",
"example": "LETTER_OF_ACCESS",
"enum": [
"CLIENT",
"COMMERCIAL",
"CONSORTIUM",
"CONTRACTOR",
"CONTRACTOR_ADDENDUM",
"CONFIDENTIALITY_AGREEMENT",
"DECLARATION_OF_REACH_CONFORMITY",
"LETTER_OF_ACCESS",
"OR_APPOINTMENT_LETTER",
"SIEF",
"SUPPLIER",
"OTHER"
]
},
"contractDate": {
"type": "string",
"description": "Contract documents only",
"format": "date",
"example": "2026-10-01"
},
"tonnageBand": {
"type": "string",
"description": "Contract documents only",
"example": "BAND_1",
"enum": [
"BAND_1",
"BAND_2",
"BAND_3",
"BAND_4",
"BAND_5",
"BAND_6",
"BAND_7",
"BAND_8",
"BAND_9",
"BAND_K_1",
"BAND_K_2",
"BAND_K_3",
"BAND_K_4",
"BAND_K_5",
"BAND_K_6",
"BAND_K_7",
"BAND_K_8",
"BAND_K_9",
"BAND_K_10",
"BAND_K_11",
"BAND_K_12",
"BAND_K_13",
"BAND_K_14",
"BAND_K_15",
"BAND_K_16",
"BAND_K_17",
"BAND_K_18",
"BAND_K_19",
"BAND_K_20",
"CEASE_OF_MANUFACTURE"
]
},
"constituents": {
"type": "array",
"description": "Contract documents only: the linked constituents, archived ones included ('archived' says which). Replaces the existing links when sent; only each constituent's id is read",
"items": {
"$ref": "#/components/schemas/ConstituentData"
}
},
"products": {
"type": "array",
"description": "Contract documents only: the linked products, archived ones included ('archived' says which). Replaces the existing links when sent; only each product's id is read",
"items": {
"$ref": "#/components/schemas/ProductData"
}
},
"entities": {
"type": "array",
"description": "Contract documents only: the linked entities, archived ones included ('archived' says which). Replaces the existing links when sent; only each entity's id is read",
"items": {
"$ref": "#/components/schemas/EntityData"
}
},
"cost": {
"type": "number",
"description": "Contract documents only: contracted cost. For LETTER_OF_ACCESS contracts this is defaulted from the substance's Letter of Access cost, as the contract form does: when constituents, legislation or tonnageBand are sent without cost, fee or currency, and the contract then names exactly one constituent, a legislation and a tonnage band with a cost in force on the contract date. A sent value is kept as is.",
"example": 1500.0
},
"fee": {
"type": "number",
"description": "Contract documents only: administration fee. For LETTER_OF_ACCESS contracts this is defaulted from the substance's Letter of Access cost, as the contract form does: when constituents, legislation or tonnageBand are sent without cost, fee or currency, and the contract then names exactly one constituent, a legislation and a tonnage band with a cost in force on the contract date. A sent value is kept as is.",
"example": 150.0
},
"paymentReceived": {
"type": "boolean",
"deprecated": true
}
}
}
Response 403 Forbidden
Response 404 Not Found
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
PATCH /api/documents/{id}¶
Partially update a Document
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "2025-31-01 Benzene CSR",
"type": "CSR",
"documentCreationDate": "2027-07-01",
"invoiceDate": "2025-07-11",
"sentViaEmail": false,
"toEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"fromEntity": null,
"invoiceType": "Commercial",
"invoiceNumber": "1234",
"currency": "EUR",
"subTotal": 100.0,
"total": 150.0,
"outstandingAmount": 10.12,
"paymentReceivedDate": "2025-07-11",
"paymentApproved": false,
"paymentApprovedDate": "2025-07-11",
"paymentApprovedBy": null,
"paymentSent": false,
"paymentSentDate": "2025-07-11",
"paymentSentBy": null,
"legislation": "EU_REACH",
"vat": 10.0,
"purchaseOrder": "PO123",
"accountantReference": "SI/23/25",
"contractType": "LETTER_OF_ACCESS",
"contractDate": "2026-10-01",
"tonnageBand": "BAND_1",
"constituents": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
}
],
"products": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
}
],
"entities": null,
"cost": 1500.0,
"fee": 150.0,
"paymentReceived": true
}
Schema of the request body
{
"required": [
"documentCreationDate",
"name",
"partitionId",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "2025-31-01 Benzene CSR"
},
"type": {
"type": "string",
"example": "CSR",
"enum": [
"DOCUMENT",
"INVOICE",
"ANALYTICAL_REPORT",
"CJD",
"CONTRACT",
"CWA",
"CSR",
"DU",
"DRC_CONSTITUENT",
"DRC",
"GENDOC",
"IUCLID",
"MEET",
"REPORT",
"RSC",
"SAFETY",
"EMAIL",
"GENERIC_EMAIL",
"INTERNAL_EMAIL"
]
},
"documentCreationDate": {
"type": "string",
"format": "date",
"example": "2027-07-01"
},
"invoiceDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"sentViaEmail": {
"type": "boolean",
"example": false
},
"toEntity": {
"$ref": "#/components/schemas/EntityData"
},
"fromEntity": {
"$ref": "#/components/schemas/EntityData"
},
"invoiceType": {
"type": "string",
"example": "Commercial",
"enum": [
"COMMERCIAL",
"OPERATIONAL",
"TECHNICAL",
"TESTING",
"SETTLEMENT",
"LETTER_OF_ACCESS"
]
},
"invoiceNumber": {
"type": "string",
"example": "1234"
},
"currency": {
"type": "string",
"description": "An invoice's currency code, or a contract's ISO 4217 currency of cost and fee",
"example": "EUR"
},
"subTotal": {
"type": "number",
"example": 100.0
},
"total": {
"type": "number",
"example": 150.0
},
"outstandingAmount": {
"type": "number"
},
"paymentReceivedDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"paymentApproved": {
"type": "boolean",
"example": false
},
"paymentApprovedDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"paymentApprovedBy": {
"$ref": "#/components/schemas/UserData"
},
"paymentSent": {
"type": "boolean",
"example": false
},
"paymentSentDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"paymentSentBy": {
"$ref": "#/components/schemas/UserData"
},
"legislation": {
"type": "string",
"description": "An invoice's or a contract's legislation",
"example": "EU_REACH",
"enum": [
"AUSTRALIA_AICIS",
"BIOCIDES",
"BRAZIL_REACH",
"CANADA_CEPA",
"CHILE_REACH",
"CHINA",
"COLOMBIA_REACH",
"EU_CLP",
"EU_FSA",
"EU_DWD",
"EU_FCM",
"EU_PPP",
"EU_REACH",
"EU_TSR",
"EURASIA_REACH",
"INDIA_REACH",
"IRIS",
"JAPAN_CSCL",
"K_REACH",
"NZ_HSNO",
"OECD_HPV",
"OSHA",
"OSPAR",
"PHILIPPINE_APMPIN",
"SARA",
"SWISS_REACH",
"TAIWAN_REACH",
"TURKEY_REACH",
"UK_REACH",
"UKRAINE_REACH",
"US_TSCA",
"OTHER",
"NO_REGULATION"
]
},
"vat": {
"type": "number",
"example": 10.0
},
"purchaseOrder": {
"type": "string",
"example": "PO123"
},
"accountantReference": {
"type": "string",
"example": "SI/23/25"
},
"contractType": {
"type": "string",
"description": "Contract documents only",
"example": "LETTER_OF_ACCESS",
"enum": [
"CLIENT",
"COMMERCIAL",
"CONSORTIUM",
"CONTRACTOR",
"CONTRACTOR_ADDENDUM",
"CONFIDENTIALITY_AGREEMENT",
"DECLARATION_OF_REACH_CONFORMITY",
"LETTER_OF_ACCESS",
"OR_APPOINTMENT_LETTER",
"SIEF",
"SUPPLIER",
"OTHER"
]
},
"contractDate": {
"type": "string",
"description": "Contract documents only",
"format": "date",
"example": "2026-10-01"
},
"tonnageBand": {
"type": "string",
"description": "Contract documents only",
"example": "BAND_1",
"enum": [
"BAND_1",
"BAND_2",
"BAND_3",
"BAND_4",
"BAND_5",
"BAND_6",
"BAND_7",
"BAND_8",
"BAND_9",
"BAND_K_1",
"BAND_K_2",
"BAND_K_3",
"BAND_K_4",
"BAND_K_5",
"BAND_K_6",
"BAND_K_7",
"BAND_K_8",
"BAND_K_9",
"BAND_K_10",
"BAND_K_11",
"BAND_K_12",
"BAND_K_13",
"BAND_K_14",
"BAND_K_15",
"BAND_K_16",
"BAND_K_17",
"BAND_K_18",
"BAND_K_19",
"BAND_K_20",
"CEASE_OF_MANUFACTURE"
]
},
"constituents": {
"type": "array",
"description": "Contract documents only: the linked constituents, archived ones included ('archived' says which). Replaces the existing links when sent; only each constituent's id is read",
"items": {
"$ref": "#/components/schemas/ConstituentData"
}
},
"products": {
"type": "array",
"description": "Contract documents only: the linked products, archived ones included ('archived' says which). Replaces the existing links when sent; only each product's id is read",
"items": {
"$ref": "#/components/schemas/ProductData"
}
},
"entities": {
"type": "array",
"description": "Contract documents only: the linked entities, archived ones included ('archived' says which). Replaces the existing links when sent; only each entity's id is read",
"items": {
"$ref": "#/components/schemas/EntityData"
}
},
"cost": {
"type": "number",
"description": "Contract documents only: contracted cost. For LETTER_OF_ACCESS contracts this is defaulted from the substance's Letter of Access cost, as the contract form does: when constituents, legislation or tonnageBand are sent without cost, fee or currency, and the contract then names exactly one constituent, a legislation and a tonnage band with a cost in force on the contract date. A sent value is kept as is.",
"example": 1500.0
},
"fee": {
"type": "number",
"description": "Contract documents only: administration fee. For LETTER_OF_ACCESS contracts this is defaulted from the substance's Letter of Access cost, as the contract form does: when constituents, legislation or tonnageBand are sent without cost, fee or currency, and the contract then names exactly one constituent, a legislation and a tonnage band with a cost in force on the contract date. A sent value is kept as is.",
"example": 150.0
},
"paymentReceived": {
"type": "boolean",
"deprecated": true
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "2025-31-01 Benzene CSR",
"type": "CSR",
"documentCreationDate": "2027-07-01",
"invoiceDate": "2025-07-11",
"sentViaEmail": false,
"toEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"fromEntity": null,
"invoiceType": "Commercial",
"invoiceNumber": "1234",
"currency": "EUR",
"subTotal": 100.0,
"total": 150.0,
"outstandingAmount": 10.12,
"paymentReceivedDate": "2025-07-11",
"paymentApproved": false,
"paymentApprovedDate": "2025-07-11",
"paymentApprovedBy": null,
"paymentSent": false,
"paymentSentDate": "2025-07-11",
"paymentSentBy": null,
"legislation": "EU_REACH",
"vat": 10.0,
"purchaseOrder": "PO123",
"accountantReference": "SI/23/25",
"contractType": "LETTER_OF_ACCESS",
"contractDate": "2026-10-01",
"tonnageBand": "BAND_1",
"constituents": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
}
],
"products": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
}
],
"entities": null,
"cost": 1500.0,
"fee": 150.0,
"paymentReceived": true
}
Schema of the response body
{
"required": [
"documentCreationDate",
"name",
"partitionId",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "2025-31-01 Benzene CSR"
},
"type": {
"type": "string",
"example": "CSR",
"enum": [
"DOCUMENT",
"INVOICE",
"ANALYTICAL_REPORT",
"CJD",
"CONTRACT",
"CWA",
"CSR",
"DU",
"DRC_CONSTITUENT",
"DRC",
"GENDOC",
"IUCLID",
"MEET",
"REPORT",
"RSC",
"SAFETY",
"EMAIL",
"GENERIC_EMAIL",
"INTERNAL_EMAIL"
]
},
"documentCreationDate": {
"type": "string",
"format": "date",
"example": "2027-07-01"
},
"invoiceDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"sentViaEmail": {
"type": "boolean",
"example": false
},
"toEntity": {
"$ref": "#/components/schemas/EntityData"
},
"fromEntity": {
"$ref": "#/components/schemas/EntityData"
},
"invoiceType": {
"type": "string",
"example": "Commercial",
"enum": [
"COMMERCIAL",
"OPERATIONAL",
"TECHNICAL",
"TESTING",
"SETTLEMENT",
"LETTER_OF_ACCESS"
]
},
"invoiceNumber": {
"type": "string",
"example": "1234"
},
"currency": {
"type": "string",
"description": "An invoice's currency code, or a contract's ISO 4217 currency of cost and fee",
"example": "EUR"
},
"subTotal": {
"type": "number",
"example": 100.0
},
"total": {
"type": "number",
"example": 150.0
},
"outstandingAmount": {
"type": "number"
},
"paymentReceivedDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"paymentApproved": {
"type": "boolean",
"example": false
},
"paymentApprovedDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"paymentApprovedBy": {
"$ref": "#/components/schemas/UserData"
},
"paymentSent": {
"type": "boolean",
"example": false
},
"paymentSentDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"paymentSentBy": {
"$ref": "#/components/schemas/UserData"
},
"legislation": {
"type": "string",
"description": "An invoice's or a contract's legislation",
"example": "EU_REACH",
"enum": [
"AUSTRALIA_AICIS",
"BIOCIDES",
"BRAZIL_REACH",
"CANADA_CEPA",
"CHILE_REACH",
"CHINA",
"COLOMBIA_REACH",
"EU_CLP",
"EU_FSA",
"EU_DWD",
"EU_FCM",
"EU_PPP",
"EU_REACH",
"EU_TSR",
"EURASIA_REACH",
"INDIA_REACH",
"IRIS",
"JAPAN_CSCL",
"K_REACH",
"NZ_HSNO",
"OECD_HPV",
"OSHA",
"OSPAR",
"PHILIPPINE_APMPIN",
"SARA",
"SWISS_REACH",
"TAIWAN_REACH",
"TURKEY_REACH",
"UK_REACH",
"UKRAINE_REACH",
"US_TSCA",
"OTHER",
"NO_REGULATION"
]
},
"vat": {
"type": "number",
"example": 10.0
},
"purchaseOrder": {
"type": "string",
"example": "PO123"
},
"accountantReference": {
"type": "string",
"example": "SI/23/25"
},
"contractType": {
"type": "string",
"description": "Contract documents only",
"example": "LETTER_OF_ACCESS",
"enum": [
"CLIENT",
"COMMERCIAL",
"CONSORTIUM",
"CONTRACTOR",
"CONTRACTOR_ADDENDUM",
"CONFIDENTIALITY_AGREEMENT",
"DECLARATION_OF_REACH_CONFORMITY",
"LETTER_OF_ACCESS",
"OR_APPOINTMENT_LETTER",
"SIEF",
"SUPPLIER",
"OTHER"
]
},
"contractDate": {
"type": "string",
"description": "Contract documents only",
"format": "date",
"example": "2026-10-01"
},
"tonnageBand": {
"type": "string",
"description": "Contract documents only",
"example": "BAND_1",
"enum": [
"BAND_1",
"BAND_2",
"BAND_3",
"BAND_4",
"BAND_5",
"BAND_6",
"BAND_7",
"BAND_8",
"BAND_9",
"BAND_K_1",
"BAND_K_2",
"BAND_K_3",
"BAND_K_4",
"BAND_K_5",
"BAND_K_6",
"BAND_K_7",
"BAND_K_8",
"BAND_K_9",
"BAND_K_10",
"BAND_K_11",
"BAND_K_12",
"BAND_K_13",
"BAND_K_14",
"BAND_K_15",
"BAND_K_16",
"BAND_K_17",
"BAND_K_18",
"BAND_K_19",
"BAND_K_20",
"CEASE_OF_MANUFACTURE"
]
},
"constituents": {
"type": "array",
"description": "Contract documents only: the linked constituents, archived ones included ('archived' says which). Replaces the existing links when sent; only each constituent's id is read",
"items": {
"$ref": "#/components/schemas/ConstituentData"
}
},
"products": {
"type": "array",
"description": "Contract documents only: the linked products, archived ones included ('archived' says which). Replaces the existing links when sent; only each product's id is read",
"items": {
"$ref": "#/components/schemas/ProductData"
}
},
"entities": {
"type": "array",
"description": "Contract documents only: the linked entities, archived ones included ('archived' says which). Replaces the existing links when sent; only each entity's id is read",
"items": {
"$ref": "#/components/schemas/EntityData"
}
},
"cost": {
"type": "number",
"description": "Contract documents only: contracted cost. For LETTER_OF_ACCESS contracts this is defaulted from the substance's Letter of Access cost, as the contract form does: when constituents, legislation or tonnageBand are sent without cost, fee or currency, and the contract then names exactly one constituent, a legislation and a tonnage band with a cost in force on the contract date. A sent value is kept as is.",
"example": 1500.0
},
"fee": {
"type": "number",
"description": "Contract documents only: administration fee. For LETTER_OF_ACCESS contracts this is defaulted from the substance's Letter of Access cost, as the contract form does: when constituents, legislation or tonnageBand are sent without cost, fee or currency, and the contract then names exactly one constituent, a legislation and a tonnage band with a cost in force on the contract date. A sent value is kept as is.",
"example": 150.0
},
"paymentReceived": {
"type": "boolean",
"deprecated": true
}
}
}
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
GET /api/documents¶
Get all Documents
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
contractType |
query | string | Yes | Filter contracts by contract type, e.g. LETTER_OF_ACCESS (use with type=CONTRACT) | |
folder |
query | integer | Yes | Filter documents by folder, including the documents in its nested folders | |
includeSubFolders |
query | boolean | True | Yes | False returns only the documents filed directly in the folder or, without 'folder', only the top-level documents that are in no folder |
page |
query | integer | 0 | Yes | Zero-based page index (0..N) |
size |
query | integer | 20 | Yes | The size of the page to be returned |
sort |
query | array | Yes | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | |
type |
query | string | Yes | Filter documents by type |
Response 200 OK
{
"totalPages": 4,
"totalElements": 84,
"size": 133,
"content": [
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "2025-31-01 Benzene CSR",
"type": "CSR",
"documentCreationDate": "2027-07-01",
"invoiceDate": "2025-07-11",
"sentViaEmail": false,
"toEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"fromEntity": null,
"invoiceType": "Commercial",
"invoiceNumber": "1234",
"currency": "EUR",
"subTotal": 100.0,
"total": 150.0,
"outstandingAmount": 10.12,
"paymentReceivedDate": "2025-07-11",
"paymentApproved": false,
"paymentApprovedDate": "2025-07-11",
"paymentApprovedBy": null,
"paymentSent": false,
"paymentSentDate": "2025-07-11",
"paymentSentBy": null,
"legislation": "EU_REACH",
"vat": 10.0,
"purchaseOrder": "PO123",
"accountantReference": "SI/23/25",
"contractType": "LETTER_OF_ACCESS",
"contractDate": "2026-10-01",
"tonnageBand": "BAND_1",
"constituents": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
}
],
"products": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
}
],
"entities": null,
"cost": 1500.0,
"fee": 150.0,
"paymentReceived": true
}
],
"number": 174,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"pageable": {
"offset": 225,
"sort": null,
"unpaged": true,
"paged": true,
"pageSize": 266,
"pageNumber": 157
},
"numberOfElements": 73,
"first": true,
"last": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
POST /api/documents¶
Create a Document
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "2025-31-01 Benzene CSR",
"type": "CSR",
"documentCreationDate": "2027-07-01",
"invoiceDate": "2025-07-11",
"sentViaEmail": false,
"toEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"fromEntity": null,
"invoiceType": "Commercial",
"invoiceNumber": "1234",
"currency": "EUR",
"subTotal": 100.0,
"total": 150.0,
"outstandingAmount": 10.12,
"paymentReceivedDate": "2025-07-11",
"paymentApproved": false,
"paymentApprovedDate": "2025-07-11",
"paymentApprovedBy": null,
"paymentSent": false,
"paymentSentDate": "2025-07-11",
"paymentSentBy": null,
"legislation": "EU_REACH",
"vat": 10.0,
"purchaseOrder": "PO123",
"accountantReference": "SI/23/25",
"contractType": "LETTER_OF_ACCESS",
"contractDate": "2026-10-01",
"tonnageBand": "BAND_1",
"constituents": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
}
],
"products": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
}
],
"entities": null,
"cost": 1500.0,
"fee": 150.0,
"paymentReceived": true
}
Schema of the request body
{
"required": [
"documentCreationDate",
"name",
"partitionId",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "2025-31-01 Benzene CSR"
},
"type": {
"type": "string",
"example": "CSR",
"enum": [
"DOCUMENT",
"INVOICE",
"ANALYTICAL_REPORT",
"CJD",
"CONTRACT",
"CWA",
"CSR",
"DU",
"DRC_CONSTITUENT",
"DRC",
"GENDOC",
"IUCLID",
"MEET",
"REPORT",
"RSC",
"SAFETY",
"EMAIL",
"GENERIC_EMAIL",
"INTERNAL_EMAIL"
]
},
"documentCreationDate": {
"type": "string",
"format": "date",
"example": "2027-07-01"
},
"invoiceDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"sentViaEmail": {
"type": "boolean",
"example": false
},
"toEntity": {
"$ref": "#/components/schemas/EntityData"
},
"fromEntity": {
"$ref": "#/components/schemas/EntityData"
},
"invoiceType": {
"type": "string",
"example": "Commercial",
"enum": [
"COMMERCIAL",
"OPERATIONAL",
"TECHNICAL",
"TESTING",
"SETTLEMENT",
"LETTER_OF_ACCESS"
]
},
"invoiceNumber": {
"type": "string",
"example": "1234"
},
"currency": {
"type": "string",
"description": "An invoice's currency code, or a contract's ISO 4217 currency of cost and fee",
"example": "EUR"
},
"subTotal": {
"type": "number",
"example": 100.0
},
"total": {
"type": "number",
"example": 150.0
},
"outstandingAmount": {
"type": "number"
},
"paymentReceivedDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"paymentApproved": {
"type": "boolean",
"example": false
},
"paymentApprovedDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"paymentApprovedBy": {
"$ref": "#/components/schemas/UserData"
},
"paymentSent": {
"type": "boolean",
"example": false
},
"paymentSentDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"paymentSentBy": {
"$ref": "#/components/schemas/UserData"
},
"legislation": {
"type": "string",
"description": "An invoice's or a contract's legislation",
"example": "EU_REACH",
"enum": [
"AUSTRALIA_AICIS",
"BIOCIDES",
"BRAZIL_REACH",
"CANADA_CEPA",
"CHILE_REACH",
"CHINA",
"COLOMBIA_REACH",
"EU_CLP",
"EU_FSA",
"EU_DWD",
"EU_FCM",
"EU_PPP",
"EU_REACH",
"EU_TSR",
"EURASIA_REACH",
"INDIA_REACH",
"IRIS",
"JAPAN_CSCL",
"K_REACH",
"NZ_HSNO",
"OECD_HPV",
"OSHA",
"OSPAR",
"PHILIPPINE_APMPIN",
"SARA",
"SWISS_REACH",
"TAIWAN_REACH",
"TURKEY_REACH",
"UK_REACH",
"UKRAINE_REACH",
"US_TSCA",
"OTHER",
"NO_REGULATION"
]
},
"vat": {
"type": "number",
"example": 10.0
},
"purchaseOrder": {
"type": "string",
"example": "PO123"
},
"accountantReference": {
"type": "string",
"example": "SI/23/25"
},
"contractType": {
"type": "string",
"description": "Contract documents only",
"example": "LETTER_OF_ACCESS",
"enum": [
"CLIENT",
"COMMERCIAL",
"CONSORTIUM",
"CONTRACTOR",
"CONTRACTOR_ADDENDUM",
"CONFIDENTIALITY_AGREEMENT",
"DECLARATION_OF_REACH_CONFORMITY",
"LETTER_OF_ACCESS",
"OR_APPOINTMENT_LETTER",
"SIEF",
"SUPPLIER",
"OTHER"
]
},
"contractDate": {
"type": "string",
"description": "Contract documents only",
"format": "date",
"example": "2026-10-01"
},
"tonnageBand": {
"type": "string",
"description": "Contract documents only",
"example": "BAND_1",
"enum": [
"BAND_1",
"BAND_2",
"BAND_3",
"BAND_4",
"BAND_5",
"BAND_6",
"BAND_7",
"BAND_8",
"BAND_9",
"BAND_K_1",
"BAND_K_2",
"BAND_K_3",
"BAND_K_4",
"BAND_K_5",
"BAND_K_6",
"BAND_K_7",
"BAND_K_8",
"BAND_K_9",
"BAND_K_10",
"BAND_K_11",
"BAND_K_12",
"BAND_K_13",
"BAND_K_14",
"BAND_K_15",
"BAND_K_16",
"BAND_K_17",
"BAND_K_18",
"BAND_K_19",
"BAND_K_20",
"CEASE_OF_MANUFACTURE"
]
},
"constituents": {
"type": "array",
"description": "Contract documents only: the linked constituents, archived ones included ('archived' says which). Replaces the existing links when sent; only each constituent's id is read",
"items": {
"$ref": "#/components/schemas/ConstituentData"
}
},
"products": {
"type": "array",
"description": "Contract documents only: the linked products, archived ones included ('archived' says which). Replaces the existing links when sent; only each product's id is read",
"items": {
"$ref": "#/components/schemas/ProductData"
}
},
"entities": {
"type": "array",
"description": "Contract documents only: the linked entities, archived ones included ('archived' says which). Replaces the existing links when sent; only each entity's id is read",
"items": {
"$ref": "#/components/schemas/EntityData"
}
},
"cost": {
"type": "number",
"description": "Contract documents only: contracted cost. For LETTER_OF_ACCESS contracts this is defaulted from the substance's Letter of Access cost, as the contract form does: when constituents, legislation or tonnageBand are sent without cost, fee or currency, and the contract then names exactly one constituent, a legislation and a tonnage band with a cost in force on the contract date. A sent value is kept as is.",
"example": 1500.0
},
"fee": {
"type": "number",
"description": "Contract documents only: administration fee. For LETTER_OF_ACCESS contracts this is defaulted from the substance's Letter of Access cost, as the contract form does: when constituents, legislation or tonnageBand are sent without cost, fee or currency, and the contract then names exactly one constituent, a legislation and a tonnage band with a cost in force on the contract date. A sent value is kept as is.",
"example": 150.0
},
"paymentReceived": {
"type": "boolean",
"deprecated": true
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "2025-31-01 Benzene CSR",
"type": "CSR",
"documentCreationDate": "2027-07-01",
"invoiceDate": "2025-07-11",
"sentViaEmail": false,
"toEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"fromEntity": null,
"invoiceType": "Commercial",
"invoiceNumber": "1234",
"currency": "EUR",
"subTotal": 100.0,
"total": 150.0,
"outstandingAmount": 10.12,
"paymentReceivedDate": "2025-07-11",
"paymentApproved": false,
"paymentApprovedDate": "2025-07-11",
"paymentApprovedBy": null,
"paymentSent": false,
"paymentSentDate": "2025-07-11",
"paymentSentBy": null,
"legislation": "EU_REACH",
"vat": 10.0,
"purchaseOrder": "PO123",
"accountantReference": "SI/23/25",
"contractType": "LETTER_OF_ACCESS",
"contractDate": "2026-10-01",
"tonnageBand": "BAND_1",
"constituents": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
}
],
"products": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
}
],
"entities": null,
"cost": 1500.0,
"fee": 150.0,
"paymentReceived": true
}
Schema of the response body
{
"required": [
"documentCreationDate",
"name",
"partitionId",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "2025-31-01 Benzene CSR"
},
"type": {
"type": "string",
"example": "CSR",
"enum": [
"DOCUMENT",
"INVOICE",
"ANALYTICAL_REPORT",
"CJD",
"CONTRACT",
"CWA",
"CSR",
"DU",
"DRC_CONSTITUENT",
"DRC",
"GENDOC",
"IUCLID",
"MEET",
"REPORT",
"RSC",
"SAFETY",
"EMAIL",
"GENERIC_EMAIL",
"INTERNAL_EMAIL"
]
},
"documentCreationDate": {
"type": "string",
"format": "date",
"example": "2027-07-01"
},
"invoiceDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"sentViaEmail": {
"type": "boolean",
"example": false
},
"toEntity": {
"$ref": "#/components/schemas/EntityData"
},
"fromEntity": {
"$ref": "#/components/schemas/EntityData"
},
"invoiceType": {
"type": "string",
"example": "Commercial",
"enum": [
"COMMERCIAL",
"OPERATIONAL",
"TECHNICAL",
"TESTING",
"SETTLEMENT",
"LETTER_OF_ACCESS"
]
},
"invoiceNumber": {
"type": "string",
"example": "1234"
},
"currency": {
"type": "string",
"description": "An invoice's currency code, or a contract's ISO 4217 currency of cost and fee",
"example": "EUR"
},
"subTotal": {
"type": "number",
"example": 100.0
},
"total": {
"type": "number",
"example": 150.0
},
"outstandingAmount": {
"type": "number"
},
"paymentReceivedDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"paymentApproved": {
"type": "boolean",
"example": false
},
"paymentApprovedDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"paymentApprovedBy": {
"$ref": "#/components/schemas/UserData"
},
"paymentSent": {
"type": "boolean",
"example": false
},
"paymentSentDate": {
"type": "string",
"format": "date",
"example": "2025-07-11"
},
"paymentSentBy": {
"$ref": "#/components/schemas/UserData"
},
"legislation": {
"type": "string",
"description": "An invoice's or a contract's legislation",
"example": "EU_REACH",
"enum": [
"AUSTRALIA_AICIS",
"BIOCIDES",
"BRAZIL_REACH",
"CANADA_CEPA",
"CHILE_REACH",
"CHINA",
"COLOMBIA_REACH",
"EU_CLP",
"EU_FSA",
"EU_DWD",
"EU_FCM",
"EU_PPP",
"EU_REACH",
"EU_TSR",
"EURASIA_REACH",
"INDIA_REACH",
"IRIS",
"JAPAN_CSCL",
"K_REACH",
"NZ_HSNO",
"OECD_HPV",
"OSHA",
"OSPAR",
"PHILIPPINE_APMPIN",
"SARA",
"SWISS_REACH",
"TAIWAN_REACH",
"TURKEY_REACH",
"UK_REACH",
"UKRAINE_REACH",
"US_TSCA",
"OTHER",
"NO_REGULATION"
]
},
"vat": {
"type": "number",
"example": 10.0
},
"purchaseOrder": {
"type": "string",
"example": "PO123"
},
"accountantReference": {
"type": "string",
"example": "SI/23/25"
},
"contractType": {
"type": "string",
"description": "Contract documents only",
"example": "LETTER_OF_ACCESS",
"enum": [
"CLIENT",
"COMMERCIAL",
"CONSORTIUM",
"CONTRACTOR",
"CONTRACTOR_ADDENDUM",
"CONFIDENTIALITY_AGREEMENT",
"DECLARATION_OF_REACH_CONFORMITY",
"LETTER_OF_ACCESS",
"OR_APPOINTMENT_LETTER",
"SIEF",
"SUPPLIER",
"OTHER"
]
},
"contractDate": {
"type": "string",
"description": "Contract documents only",
"format": "date",
"example": "2026-10-01"
},
"tonnageBand": {
"type": "string",
"description": "Contract documents only",
"example": "BAND_1",
"enum": [
"BAND_1",
"BAND_2",
"BAND_3",
"BAND_4",
"BAND_5",
"BAND_6",
"BAND_7",
"BAND_8",
"BAND_9",
"BAND_K_1",
"BAND_K_2",
"BAND_K_3",
"BAND_K_4",
"BAND_K_5",
"BAND_K_6",
"BAND_K_7",
"BAND_K_8",
"BAND_K_9",
"BAND_K_10",
"BAND_K_11",
"BAND_K_12",
"BAND_K_13",
"BAND_K_14",
"BAND_K_15",
"BAND_K_16",
"BAND_K_17",
"BAND_K_18",
"BAND_K_19",
"BAND_K_20",
"CEASE_OF_MANUFACTURE"
]
},
"constituents": {
"type": "array",
"description": "Contract documents only: the linked constituents, archived ones included ('archived' says which). Replaces the existing links when sent; only each constituent's id is read",
"items": {
"$ref": "#/components/schemas/ConstituentData"
}
},
"products": {
"type": "array",
"description": "Contract documents only: the linked products, archived ones included ('archived' says which). Replaces the existing links when sent; only each product's id is read",
"items": {
"$ref": "#/components/schemas/ProductData"
}
},
"entities": {
"type": "array",
"description": "Contract documents only: the linked entities, archived ones included ('archived' says which). Replaces the existing links when sent; only each entity's id is read",
"items": {
"$ref": "#/components/schemas/EntityData"
}
},
"cost": {
"type": "number",
"description": "Contract documents only: contracted cost. For LETTER_OF_ACCESS contracts this is defaulted from the substance's Letter of Access cost, as the contract form does: when constituents, legislation or tonnageBand are sent without cost, fee or currency, and the contract then names exactly one constituent, a legislation and a tonnage band with a cost in force on the contract date. A sent value is kept as is.",
"example": 1500.0
},
"fee": {
"type": "number",
"description": "Contract documents only: administration fee. For LETTER_OF_ACCESS contracts this is defaulted from the substance's Letter of Access cost, as the contract form does: when constituents, legislation or tonnageBand are sent without cost, fee or currency, and the contract then names exactly one constituent, a legislation and a tonnage band with a cost in force on the contract date. A sent value is kept as is.",
"example": 150.0
},
"paymentReceived": {
"type": "boolean",
"deprecated": true
}
}
}
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
POST /api/documents/invoices¶
Create invoices
Description
Same as Create Invoice(s) in the UI: one invoice per entity in 'invoices', each with every line in 'items', created through the partition's invoicing integration. Each field of the body says when it is required. Name a 'basedOnDocument' (e.g. a Letter of Access contract) to have the fields inferred from it, as GET /api/documents/invoices/preview shows them; the fields sent overwrite what is inferred, and the invoices are linked to the document. Safe to retry when based on a document: if it already has a linked invoice this returns 409 with the invoice ids, unless force=true. For iplicit, each invoice is created UNPOSTED, as from the UI: its PDF only exists once it's posted in iplicit. Post it through iplicit's API using the returned iplicitId, then import it with POST /api/invoices/iplicit/sync.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
force |
query | boolean | False | Yes | Create invoices even though the basedOnDocument already has some |
Request body
{
"basedOnDocument": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "2025-31-01 Benzene CSR",
"type": "CSR",
"documentCreationDate": "2027-07-01",
"invoiceDate": "2025-07-11",
"sentViaEmail": false,
"toEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"fromEntity": null,
"invoiceType": "Commercial",
"invoiceNumber": "1234",
"currency": "EUR",
"subTotal": 100.0,
"total": 150.0,
"outstandingAmount": 10.12,
"paymentReceivedDate": "2025-07-11",
"paymentApproved": false,
"paymentApprovedDate": "2025-07-11",
"paymentApprovedBy": null,
"paymentSent": false,
"paymentSentDate": "2025-07-11",
"paymentSentBy": null,
"legislation": "EU_REACH",
"vat": 10.0,
"purchaseOrder": "PO123",
"accountantReference": "SI/23/25",
"contractType": "LETTER_OF_ACCESS",
"contractDate": "2026-10-01",
"tonnageBand": "BAND_1",
"constituents": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
}
],
"products": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
}
],
"entities": null,
"cost": 1500.0,
"fee": 150.0,
"paymentReceived": true
},
"partitionId": 100,
"integrationId": 93,
"integrationType": "BOCOUNT_EXPORT_INVOICES",
"type": "INVOICE",
"currency": "EUR",
"fromEntity": null,
"async": true,
"items": [
{
"description": "Letter of Access for Benzene - 10-100 tonnes",
"amount": 2500.0,
"taxed": true,
"accountId": "ea0a3eeb-69c1-40a1-975d-48a8a2f22264",
"account": "string",
"departmentId": "1ffa6cd4-4890-4e1c-a8f5-85b6a95a4b3b",
"department": "string",
"salesCode": "string",
"constituents": null,
"products": null
}
],
"invoices": [
{
"entity": null,
"amounts": [
10.12
]
}
]
}
Schema of the request body
{
"type": "object",
"properties": {
"basedOnDocument": {
"$ref": "#/components/schemas/DocumentData"
},
"partitionId": {
"type": "integer",
"description": "Partition to create the invoices in. Required for an API key unless basedOnDocument is given, whose partition is then used. A logged-in user always invoices in their current partition",
"format": "int64",
"example": 100
},
"integrationId": {
"type": "integer",
"description": "Integration (e.g. iplicit, QuickBooks, BoCount export) to create the invoices through. Required only when the partition has more than one invoicing integration; with exactly one, that one is used",
"format": "int64"
},
"integrationType": {
"type": "string",
"description": "Type of the integration used",
"readOnly": true,
"enum": [
"BOCOUNT_EXPORT_INVOICES",
"BOCOUNT_IMPORT_INVOICES",
"BOCOUNT_IMPORT_LEDGERS",
"ECHA_CLOUD",
"IPLICIT",
"IUCLID",
"MINDEE",
"QUICKBOOKS"
]
},
"type": {
"type": "string",
"description": "Kind of invoice. INVOICE and CREDIT_MEMO work with every integration; the other values are iplicit document types. Required, unless one can be inferred: INVOICE_PENMAN_LETTER_OF_ACCESS when basedOnDocument is a Letter of Access contract, and INVOICE_CONSORTIA on the consortia instance. If supplied, any inferred type is overwritten",
"example": "INVOICE",
"enum": [
"INVOICE",
"INVOICE_CONSORTIA",
"INVOICE_PENMAN",
"INVOICE_PENMAN_LETTER_OF_ACCESS",
"INVOICE_PROJECT",
"INVOICE_PROJECT_PARENT",
"CREDIT_MEMO"
]
},
"currency": {
"type": "string",
"description": "ISO currency code of the invoices. Optional: inferred from basedOnDocument when it is a contract with a currency, else the instance's base currency. If supplied, the inferred currency is overwritten",
"example": "EUR"
},
"fromEntity": {
"$ref": "#/components/schemas/EntityData"
},
"async": {
"type": "boolean",
"description": "iplicit only: create the invoices in iplicit in the background, so the response has no iplicit ids. Default false"
},
"items": {
"type": "array",
"description": "Lines on every invoice, in order. Required unless basedOnDocument is given, which infers them: a contract's administration fee, and for a Letter of Access contract its cost. When sent, they replace every inferred line, and a sent line keeps only what it sends",
"items": {
"$ref": "#/components/schemas/ItemData"
}
},
"invoices": {
"type": "array",
"description": "Invoices to create, one per entity invoiced. Required unless basedOnDocument is given, which infers them: one per entity linked to the document. When sent, they replace the inferred ones; only each 'entity' is read, and every invoice gets each line's amount",
"items": {
"$ref": "#/components/schemas/InvoiceeData"
}
}
},
"description": "Invoices to create: one invoice per entity in 'invoices', each with every line in 'items'. Name a 'basedOnDocument' to have fields inferred from it; each field says what is inferred and when it is required"
}
Response 200 OK
{
"invoices": [
{
"document": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "2025-31-01 Benzene CSR",
"type": "CSR",
"documentCreationDate": "2027-07-01",
"invoiceDate": "2025-07-11",
"sentViaEmail": false,
"toEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"fromEntity": null,
"invoiceType": "Commercial",
"invoiceNumber": "1234",
"currency": "EUR",
"subTotal": 100.0,
"total": 150.0,
"outstandingAmount": 10.12,
"paymentReceivedDate": "2025-07-11",
"paymentApproved": false,
"paymentApprovedDate": "2025-07-11",
"paymentApprovedBy": null,
"paymentSent": false,
"paymentSentDate": "2025-07-11",
"paymentSentBy": null,
"legislation": "EU_REACH",
"vat": 10.0,
"purchaseOrder": "PO123",
"accountantReference": "SI/23/25",
"contractType": "LETTER_OF_ACCESS",
"contractDate": "2026-10-01",
"tonnageBand": "BAND_1",
"constituents": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
}
],
"products": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
}
],
"entities": null,
"cost": 1500.0,
"fee": 150.0,
"paymentReceived": true
},
"iplicitId": "3104a920-5cb5-4823-ad99-3b1df741b5d6",
"iplicitDocNo": "string"
}
],
"form": {
"basedOnDocument": null,
"partitionId": 100,
"integrationId": 37,
"integrationType": "BOCOUNT_EXPORT_INVOICES",
"type": "INVOICE",
"currency": "EUR",
"fromEntity": null,
"async": true,
"items": [
{
"description": "Letter of Access for Benzene - 10-100 tonnes",
"amount": 2500.0,
"taxed": true,
"accountId": "598f59f0-1983-40de-a761-4713049d3af9",
"account": "string",
"departmentId": "31da3cf1-9a68-42c1-9c83-12c928b85ea3",
"department": "string",
"salesCode": "string",
"constituents": null,
"products": null
}
],
"invoices": [
{
"entity": null,
"amounts": [
10.12
]
}
]
}
}
Schema of the response body
{
"type": "object",
"properties": {
"invoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreatedInvoiceData"
}
},
"form": {
"$ref": "#/components/schemas/InvoiceFormData"
}
},
"description": "Invoices created from a document, and the form they were created from"
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 409 Conflict
Response 502 Bad Gateway
GET /api/documents/{id}/file¶
Download a Document's file
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
"TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
Schema of the response body
{
"type": "string",
"format": "byte"
}
Response 204 No Content
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
GET /api/documents/invoices/preview¶
Preview invoices
Description
Returns the invoice form as Create Invoice(s) in the UI fills it in, without creating anything: based on a document, everything inferred from it; otherwise only the defaults (integration, currency, 'from' entity). Send it back, changed as needed, to POST /api/documents/invoices.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
basedOnDocumentId |
query | integer | Yes | Id of the document to base the invoices on, e.g. a Letter of Access contract | |
integrationId |
query | integer | Yes | Integration to invoice through. Required only when the partition has more than one | |
partitionId |
query | integer | Yes | Partition to invoice in. Required for an API key unless basedOnDocumentId is given, whose partition is then used |
Response 200 OK
{
"basedOnDocument": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "2025-31-01 Benzene CSR",
"type": "CSR",
"documentCreationDate": "2027-07-01",
"invoiceDate": "2025-07-11",
"sentViaEmail": false,
"toEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"fromEntity": null,
"invoiceType": "Commercial",
"invoiceNumber": "1234",
"currency": "EUR",
"subTotal": 100.0,
"total": 150.0,
"outstandingAmount": 10.12,
"paymentReceivedDate": "2025-07-11",
"paymentApproved": false,
"paymentApprovedDate": "2025-07-11",
"paymentApprovedBy": null,
"paymentSent": false,
"paymentSentDate": "2025-07-11",
"paymentSentBy": null,
"legislation": "EU_REACH",
"vat": 10.0,
"purchaseOrder": "PO123",
"accountantReference": "SI/23/25",
"contractType": "LETTER_OF_ACCESS",
"contractDate": "2026-10-01",
"tonnageBand": "BAND_1",
"constituents": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
}
],
"products": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
}
],
"entities": null,
"cost": 1500.0,
"fee": 150.0,
"paymentReceived": true
},
"partitionId": 100,
"integrationId": 285,
"integrationType": "BOCOUNT_EXPORT_INVOICES",
"type": "INVOICE",
"currency": "EUR",
"fromEntity": null,
"async": true,
"items": [
{
"description": "Letter of Access for Benzene - 10-100 tonnes",
"amount": 2500.0,
"taxed": true,
"accountId": "a8110f30-3f66-49cd-8613-8264a128b2ab",
"account": "string",
"departmentId": "5b229637-99f2-4c06-9aa2-8dd14607a6f0",
"department": "string",
"salesCode": "string",
"constituents": null,
"products": null
}
],
"invoices": [
{
"entity": null,
"amounts": [
10.12
]
}
]
}
Schema of the response body
{
"type": "object",
"properties": {
"basedOnDocument": {
"$ref": "#/components/schemas/DocumentData"
},
"partitionId": {
"type": "integer",
"description": "Partition to create the invoices in. Required for an API key unless basedOnDocument is given, whose partition is then used. A logged-in user always invoices in their current partition",
"format": "int64",
"example": 100
},
"integrationId": {
"type": "integer",
"description": "Integration (e.g. iplicit, QuickBooks, BoCount export) to create the invoices through. Required only when the partition has more than one invoicing integration; with exactly one, that one is used",
"format": "int64"
},
"integrationType": {
"type": "string",
"description": "Type of the integration used",
"readOnly": true,
"enum": [
"BOCOUNT_EXPORT_INVOICES",
"BOCOUNT_IMPORT_INVOICES",
"BOCOUNT_IMPORT_LEDGERS",
"ECHA_CLOUD",
"IPLICIT",
"IUCLID",
"MINDEE",
"QUICKBOOKS"
]
},
"type": {
"type": "string",
"description": "Kind of invoice. INVOICE and CREDIT_MEMO work with every integration; the other values are iplicit document types. Required, unless one can be inferred: INVOICE_PENMAN_LETTER_OF_ACCESS when basedOnDocument is a Letter of Access contract, and INVOICE_CONSORTIA on the consortia instance. If supplied, any inferred type is overwritten",
"example": "INVOICE",
"enum": [
"INVOICE",
"INVOICE_CONSORTIA",
"INVOICE_PENMAN",
"INVOICE_PENMAN_LETTER_OF_ACCESS",
"INVOICE_PROJECT",
"INVOICE_PROJECT_PARENT",
"CREDIT_MEMO"
]
},
"currency": {
"type": "string",
"description": "ISO currency code of the invoices. Optional: inferred from basedOnDocument when it is a contract with a currency, else the instance's base currency. If supplied, the inferred currency is overwritten",
"example": "EUR"
},
"fromEntity": {
"$ref": "#/components/schemas/EntityData"
},
"async": {
"type": "boolean",
"description": "iplicit only: create the invoices in iplicit in the background, so the response has no iplicit ids. Default false"
},
"items": {
"type": "array",
"description": "Lines on every invoice, in order. Required unless basedOnDocument is given, which infers them: a contract's administration fee, and for a Letter of Access contract its cost. When sent, they replace every inferred line, and a sent line keeps only what it sends",
"items": {
"$ref": "#/components/schemas/ItemData"
}
},
"invoices": {
"type": "array",
"description": "Invoices to create, one per entity invoiced. Required unless basedOnDocument is given, which infers them: one per entity linked to the document. When sent, they replace the inferred ones; only each 'entity' is read, and every invoice gets each line's amount",
"items": {
"$ref": "#/components/schemas/InvoiceeData"
}
}
},
"description": "Invoices to create: one invoice per entity in 'invoices', each with every line in 'items'. Name a 'basedOnDocument' to have fields inferred from it; each field says what is inferred and when it is required"
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 502 Bad Gateway
Contacts¶
GET /api/contacts/{id}¶
Get a Contact
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false,
"lastLoggedIn": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"required": [
"email",
"firstName",
"lastName",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"title": {
"type": "string",
"example": "MR",
"enum": [
"MR",
"MISS",
"MRS",
"MS",
"DR",
"PROF"
]
},
"firstName": {
"minLength": 1,
"type": "string",
"example": "James"
},
"lastName": {
"minLength": 1,
"type": "string",
"example": "Smith"
},
"nameSuffix": {
"type": "string",
"example": "MR"
},
"jobDescription": {
"type": "string",
"example": "Environmental Scientist"
},
"email": {
"minLength": 1,
"type": "string",
"example": "john.smith@example.com"
},
"telephone": {
"type": "string"
},
"fax": {
"type": "string"
},
"mobile": {
"type": "string"
},
"skype": {
"type": "string"
},
"archived": {
"type": "boolean",
"description": "True if the contact has been archived",
"readOnly": true,
"example": false
},
"lastLoggedIn": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
}
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
PUT /api/contacts/{id}¶
Fully Update a contact
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false,
"lastLoggedIn": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"required": [
"email",
"firstName",
"lastName",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"title": {
"type": "string",
"example": "MR",
"enum": [
"MR",
"MISS",
"MRS",
"MS",
"DR",
"PROF"
]
},
"firstName": {
"minLength": 1,
"type": "string",
"example": "James"
},
"lastName": {
"minLength": 1,
"type": "string",
"example": "Smith"
},
"nameSuffix": {
"type": "string",
"example": "MR"
},
"jobDescription": {
"type": "string",
"example": "Environmental Scientist"
},
"email": {
"minLength": 1,
"type": "string",
"example": "john.smith@example.com"
},
"telephone": {
"type": "string"
},
"fax": {
"type": "string"
},
"mobile": {
"type": "string"
},
"skype": {
"type": "string"
},
"archived": {
"type": "boolean",
"description": "True if the contact has been archived",
"readOnly": true,
"example": false
},
"lastLoggedIn": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false,
"lastLoggedIn": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"required": [
"email",
"firstName",
"lastName",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"title": {
"type": "string",
"example": "MR",
"enum": [
"MR",
"MISS",
"MRS",
"MS",
"DR",
"PROF"
]
},
"firstName": {
"minLength": 1,
"type": "string",
"example": "James"
},
"lastName": {
"minLength": 1,
"type": "string",
"example": "Smith"
},
"nameSuffix": {
"type": "string",
"example": "MR"
},
"jobDescription": {
"type": "string",
"example": "Environmental Scientist"
},
"email": {
"minLength": 1,
"type": "string",
"example": "john.smith@example.com"
},
"telephone": {
"type": "string"
},
"fax": {
"type": "string"
},
"mobile": {
"type": "string"
},
"skype": {
"type": "string"
},
"archived": {
"type": "boolean",
"description": "True if the contact has been archived",
"readOnly": true,
"example": false
},
"lastLoggedIn": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
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
PATCH /api/contacts/{id}¶
Partially Update a Contact
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false,
"lastLoggedIn": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"required": [
"email",
"firstName",
"lastName",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"title": {
"type": "string",
"example": "MR",
"enum": [
"MR",
"MISS",
"MRS",
"MS",
"DR",
"PROF"
]
},
"firstName": {
"minLength": 1,
"type": "string",
"example": "James"
},
"lastName": {
"minLength": 1,
"type": "string",
"example": "Smith"
},
"nameSuffix": {
"type": "string",
"example": "MR"
},
"jobDescription": {
"type": "string",
"example": "Environmental Scientist"
},
"email": {
"minLength": 1,
"type": "string",
"example": "john.smith@example.com"
},
"telephone": {
"type": "string"
},
"fax": {
"type": "string"
},
"mobile": {
"type": "string"
},
"skype": {
"type": "string"
},
"archived": {
"type": "boolean",
"description": "True if the contact has been archived",
"readOnly": true,
"example": false
},
"lastLoggedIn": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false,
"lastLoggedIn": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"required": [
"email",
"firstName",
"lastName",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"title": {
"type": "string",
"example": "MR",
"enum": [
"MR",
"MISS",
"MRS",
"MS",
"DR",
"PROF"
]
},
"firstName": {
"minLength": 1,
"type": "string",
"example": "James"
},
"lastName": {
"minLength": 1,
"type": "string",
"example": "Smith"
},
"nameSuffix": {
"type": "string",
"example": "MR"
},
"jobDescription": {
"type": "string",
"example": "Environmental Scientist"
},
"email": {
"minLength": 1,
"type": "string",
"example": "john.smith@example.com"
},
"telephone": {
"type": "string"
},
"fax": {
"type": "string"
},
"mobile": {
"type": "string"
},
"skype": {
"type": "string"
},
"archived": {
"type": "boolean",
"description": "True if the contact has been archived",
"readOnly": true,
"example": false
},
"lastLoggedIn": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
GET /api/contacts¶
Get All Contacts
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
archived |
query | boolean | Yes | True to return archived contacts only, false for active contacts only; all contacts are returned by default | |
entity |
query | integer | Yes | Filter contacts by entity | |
page |
query | integer | 0 | Yes | Zero-based page index (0..N) |
size |
query | integer | 20 | Yes | The size of the page to be returned |
sort |
query | array | Yes | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Response 200 OK
{
"totalPages": 84,
"totalElements": 148,
"size": 32,
"content": [
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false,
"lastLoggedIn": "2022-04-13T15:42:05.901Z"
}
],
"number": 32,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"pageable": {
"offset": 10,
"sort": null,
"unpaged": true,
"paged": true,
"pageSize": 133,
"pageNumber": 220
},
"numberOfElements": 278,
"first": true,
"last": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
POST /api/contacts¶
Create a Contact
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false,
"lastLoggedIn": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"required": [
"email",
"firstName",
"lastName",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"title": {
"type": "string",
"example": "MR",
"enum": [
"MR",
"MISS",
"MRS",
"MS",
"DR",
"PROF"
]
},
"firstName": {
"minLength": 1,
"type": "string",
"example": "James"
},
"lastName": {
"minLength": 1,
"type": "string",
"example": "Smith"
},
"nameSuffix": {
"type": "string",
"example": "MR"
},
"jobDescription": {
"type": "string",
"example": "Environmental Scientist"
},
"email": {
"minLength": 1,
"type": "string",
"example": "john.smith@example.com"
},
"telephone": {
"type": "string"
},
"fax": {
"type": "string"
},
"mobile": {
"type": "string"
},
"skype": {
"type": "string"
},
"archived": {
"type": "boolean",
"description": "True if the contact has been archived",
"readOnly": true,
"example": false
},
"lastLoggedIn": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false,
"lastLoggedIn": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"required": [
"email",
"firstName",
"lastName",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"title": {
"type": "string",
"example": "MR",
"enum": [
"MR",
"MISS",
"MRS",
"MS",
"DR",
"PROF"
]
},
"firstName": {
"minLength": 1,
"type": "string",
"example": "James"
},
"lastName": {
"minLength": 1,
"type": "string",
"example": "Smith"
},
"nameSuffix": {
"type": "string",
"example": "MR"
},
"jobDescription": {
"type": "string",
"example": "Environmental Scientist"
},
"email": {
"minLength": 1,
"type": "string",
"example": "john.smith@example.com"
},
"telephone": {
"type": "string"
},
"fax": {
"type": "string"
},
"mobile": {
"type": "string"
},
"skype": {
"type": "string"
},
"archived": {
"type": "boolean",
"description": "True if the contact has been archived",
"readOnly": true,
"example": false
},
"lastLoggedIn": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 500 Internal Server Error
POST /api/contacts/{contactId}/addresses/{addressId}¶
Link an address to a contact
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
addressId |
path | integer | No | ||
contactId |
path | integer | No |
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false,
"lastLoggedIn": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"required": [
"email",
"firstName",
"lastName",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"title": {
"type": "string",
"example": "MR",
"enum": [
"MR",
"MISS",
"MRS",
"MS",
"DR",
"PROF"
]
},
"firstName": {
"minLength": 1,
"type": "string",
"example": "James"
},
"lastName": {
"minLength": 1,
"type": "string",
"example": "Smith"
},
"nameSuffix": {
"type": "string",
"example": "MR"
},
"jobDescription": {
"type": "string",
"example": "Environmental Scientist"
},
"email": {
"minLength": 1,
"type": "string",
"example": "john.smith@example.com"
},
"telephone": {
"type": "string"
},
"fax": {
"type": "string"
},
"mobile": {
"type": "string"
},
"skype": {
"type": "string"
},
"archived": {
"type": "boolean",
"description": "True if the contact has been archived",
"readOnly": true,
"example": false
},
"lastLoggedIn": {
"type": "string",
"format": "date-time",
"readOnly": true
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 500 Internal Server Error
DELETE /api/contacts/{contactId}/addresses/{addressId}¶
Delete the address link for a contact
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
addressId |
path | integer | No | ||
contactId |
path | integer | No |
Response 204 No Content
Response 403 Forbidden
Response 500 Internal Server Error
Constituents¶
GET /api/constituents/{id}¶
Get a Constituent
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
}
Schema of the response body
{
"required": [
"name",
"partitionId",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Benzene"
},
"type": {
"type": "string",
"description": "Composition item type code; valid values from GET /api/constituent-types. The nine legacy codes are SUBSTANCE, MIXTURE, ACTIVE_INGREDIENT, ARTICLE, BLEND, CO_FORMULANT, MONOMER, POLYMER and UN_SPECIFIED; an instance may define more.",
"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"
},
"archived": {
"type": "boolean",
"example": false
}
}
}
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
PUT /api/constituents/{id}¶
Fully Update a Constituent
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
}
Schema of the request body
{
"required": [
"name",
"partitionId",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Benzene"
},
"type": {
"type": "string",
"description": "Composition item type code; valid values from GET /api/constituent-types. The nine legacy codes are SUBSTANCE, MIXTURE, ACTIVE_INGREDIENT, ARTICLE, BLEND, CO_FORMULANT, MONOMER, POLYMER and UN_SPECIFIED; an instance may define more.",
"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"
},
"archived": {
"type": "boolean",
"example": false
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
}
Schema of the response body
{
"required": [
"name",
"partitionId",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Benzene"
},
"type": {
"type": "string",
"description": "Composition item type code; valid values from GET /api/constituent-types. The nine legacy codes are SUBSTANCE, MIXTURE, ACTIVE_INGREDIENT, ARTICLE, BLEND, CO_FORMULANT, MONOMER, POLYMER and UN_SPECIFIED; an instance may define more.",
"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"
},
"archived": {
"type": "boolean",
"example": false
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
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,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
}
Schema of the request body
{
"required": [
"name",
"partitionId",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Benzene"
},
"type": {
"type": "string",
"description": "Composition item type code; valid values from GET /api/constituent-types. The nine legacy codes are SUBSTANCE, MIXTURE, ACTIVE_INGREDIENT, ARTICLE, BLEND, CO_FORMULANT, MONOMER, POLYMER and UN_SPECIFIED; an instance may define more.",
"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"
},
"archived": {
"type": "boolean",
"example": false
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
}
Schema of the response body
{
"required": [
"name",
"partitionId",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Benzene"
},
"type": {
"type": "string",
"description": "Composition item type code; valid values from GET /api/constituent-types. The nine legacy codes are SUBSTANCE, MIXTURE, ACTIVE_INGREDIENT, ARTICLE, BLEND, CO_FORMULANT, MONOMER, POLYMER and UN_SPECIFIED; an instance may define more.",
"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"
},
"archived": {
"type": "boolean",
"example": false
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
GET /api/constituents¶
Get All Constituents
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
page |
query | integer | 0 | Yes | Zero-based page index (0..N) |
size |
query | integer | 20 | Yes | The size of the page to be returned |
sort |
query | array | Yes | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | |
study |
query | integer | Yes | Filter Constituents by Study |
Response 200 OK
{
"totalPages": 75,
"totalElements": 278,
"size": 280,
"content": [
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
}
],
"number": 295,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"pageable": {
"offset": 152,
"sort": null,
"unpaged": true,
"paged": true,
"pageSize": 54,
"pageNumber": 102
},
"numberOfElements": 104,
"first": true,
"last": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConstituentData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
POST /api/constituents¶
Create a Constituent
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
}
Schema of the request body
{
"required": [
"name",
"partitionId",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Benzene"
},
"type": {
"type": "string",
"description": "Composition item type code; valid values from GET /api/constituent-types. The nine legacy codes are SUBSTANCE, MIXTURE, ACTIVE_INGREDIENT, ARTICLE, BLEND, CO_FORMULANT, MONOMER, POLYMER and UN_SPECIFIED; an instance may define more.",
"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"
},
"archived": {
"type": "boolean",
"example": false
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
}
Schema of the response body
{
"required": [
"name",
"partitionId",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"partitionId": {
"type": "integer",
"format": "int64",
"example": 100
},
"name": {
"minLength": 1,
"type": "string",
"example": "Benzene"
},
"type": {
"type": "string",
"description": "Composition item type code; valid values from GET /api/constituent-types. The nine legacy codes are SUBSTANCE, MIXTURE, ACTIVE_INGREDIENT, ARTICLE, BLEND, CO_FORMULANT, MONOMER, POLYMER and UN_SPECIFIED; an instance may define more.",
"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"
},
"archived": {
"type": "boolean",
"example": false
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 500 Internal Server Error
Constituent Entity Links¶
GET /api/constituents/entities/{id}¶
Get a Constituent-Entity Link
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"roles": [
{
"display": "Registrant",
"id": "REGISTRANT"
}
],
"end": "2027-07-03",
"start": "2025-10-03"
}
Schema of the response body
{
"required": [
"constituent",
"entity"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"entity": {
"$ref": "#/components/schemas/EntityData"
},
"roles": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityRoleData"
}
},
"end": {
"type": "string",
"format": "date",
"example": "2027-07-03"
},
"start": {
"type": "string",
"format": "date",
"example": "2025-10-03"
}
}
}
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
PUT /api/constituents/entities/{id}¶
Fully Update Constituent-Entity Link
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"roles": [
{
"display": "Registrant",
"id": "REGISTRANT"
}
],
"end": "2027-07-03",
"start": "2025-10-03"
}
Schema of the request body
{
"required": [
"constituent",
"entity"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"entity": {
"$ref": "#/components/schemas/EntityData"
},
"roles": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityRoleData"
}
},
"end": {
"type": "string",
"format": "date",
"example": "2027-07-03"
},
"start": {
"type": "string",
"format": "date",
"example": "2025-10-03"
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"roles": [
{
"display": "Registrant",
"id": "REGISTRANT"
}
],
"end": "2027-07-03",
"start": "2025-10-03"
}
Schema of the response body
{
"required": [
"constituent",
"entity"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"entity": {
"$ref": "#/components/schemas/EntityData"
},
"roles": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityRoleData"
}
},
"end": {
"type": "string",
"format": "date",
"example": "2027-07-03"
},
"start": {
"type": "string",
"format": "date",
"example": "2025-10-03"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
DELETE /api/constituents/entities/{id}¶
Delete Constituent-Entity Link
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"roles": [
{
"display": "Registrant",
"id": "REGISTRANT"
}
],
"end": "2027-07-03",
"start": "2025-10-03"
}
Schema of the response body
{
"required": [
"constituent",
"entity"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"entity": {
"$ref": "#/components/schemas/EntityData"
},
"roles": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityRoleData"
}
},
"end": {
"type": "string",
"format": "date",
"example": "2027-07-03"
},
"start": {
"type": "string",
"format": "date",
"example": "2025-10-03"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
PATCH /api/constituents/entities/{id}¶
Partially Update Constituent-Entity Link
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"roles": [
{
"display": "Registrant",
"id": "REGISTRANT"
}
],
"end": "2027-07-03",
"start": "2025-10-03"
}
Schema of the request body
{
"required": [
"constituent",
"entity"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"entity": {
"$ref": "#/components/schemas/EntityData"
},
"roles": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityRoleData"
}
},
"end": {
"type": "string",
"format": "date",
"example": "2027-07-03"
},
"start": {
"type": "string",
"format": "date",
"example": "2025-10-03"
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"roles": [
{
"display": "Registrant",
"id": "REGISTRANT"
}
],
"end": "2027-07-03",
"start": "2025-10-03"
}
Schema of the response body
{
"required": [
"constituent",
"entity"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"entity": {
"$ref": "#/components/schemas/EntityData"
},
"roles": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityRoleData"
}
},
"end": {
"type": "string",
"format": "date",
"example": "2027-07-03"
},
"start": {
"type": "string",
"format": "date",
"example": "2025-10-03"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
GET /api/constituents/entities¶
Get all Constituent-Entity links
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
constituent |
query | integer | Yes | Filter links by constituent | |
page |
query | integer | 0 | Yes | Zero-based page index (0..N) |
size |
query | integer | 20 | Yes | The size of the page to be returned |
sort |
query | array | Yes | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Response 200 OK
{
"totalPages": 222,
"totalElements": 217,
"size": 88,
"content": [
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"roles": [
{
"display": "Registrant",
"id": "REGISTRANT"
}
],
"end": "2027-07-03",
"start": "2025-10-03"
}
],
"number": 241,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"pageable": {
"offset": 220,
"sort": null,
"unpaged": true,
"paged": true,
"pageSize": 255,
"pageNumber": 277
},
"numberOfElements": 216,
"first": true,
"last": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConstituentEntityData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
POST /api/constituents/entities¶
Create new Constituent-Entity Link
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"roles": [
{
"display": "Registrant",
"id": "REGISTRANT"
}
],
"end": "2027-07-03",
"start": "2025-10-03"
}
Schema of the request body
{
"required": [
"constituent",
"entity"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"entity": {
"$ref": "#/components/schemas/EntityData"
},
"roles": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityRoleData"
}
},
"end": {
"type": "string",
"format": "date",
"example": "2027-07-03"
},
"start": {
"type": "string",
"format": "date",
"example": "2025-10-03"
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"roles": [
{
"display": "Registrant",
"id": "REGISTRANT"
}
],
"end": "2027-07-03",
"start": "2025-10-03"
}
Schema of the response body
{
"required": [
"constituent",
"entity"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"entity": {
"$ref": "#/components/schemas/EntityData"
},
"roles": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityRoleData"
}
},
"end": {
"type": "string",
"format": "date",
"example": "2027-07-03"
},
"start": {
"type": "string",
"format": "date",
"example": "2025-10-03"
}
}
}
Response 403 Forbidden
Response 400 Bad Request
Response 500 Internal Server Error
Constituent Address Links¶
GET /api/constituents/addresses/{id}¶
Get a Constituent-Address Link
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"constituent": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"address": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"type": "SITE",
"name": "Alvanco Manufacturing Site",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"townCity": "string",
"countyStateRegion": "string",
"postcode": "string",
"country": {
"id": 244,
"name": "string",
"iso3166alpha2CountryCode": "string",
"iso3166alpha3CountryCode": "string"
}
}
}
Schema of the response body
{
"required": [
"address",
"constituent"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"address": {
"$ref": "#/components/schemas/PartyData"
}
}
}
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
PUT /api/constituents/addresses/{id}¶
Fully Update Constituent-Address Link
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"constituent": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"address": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"type": "SITE",
"name": "Alvanco Manufacturing Site",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"townCity": "string",
"countyStateRegion": "string",
"postcode": "string",
"country": {
"id": 243,
"name": "string",
"iso3166alpha2CountryCode": "string",
"iso3166alpha3CountryCode": "string"
}
}
}
Schema of the request body
{
"required": [
"address",
"constituent"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"address": {
"$ref": "#/components/schemas/PartyData"
}
}
}
Response 200 OK
{
"id": 1,
"constituent": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"address": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"type": "SITE",
"name": "Alvanco Manufacturing Site",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"townCity": "string",
"countyStateRegion": "string",
"postcode": "string",
"country": {
"id": 278,
"name": "string",
"iso3166alpha2CountryCode": "string",
"iso3166alpha3CountryCode": "string"
}
}
}
Schema of the response body
{
"required": [
"address",
"constituent"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"address": {
"$ref": "#/components/schemas/PartyData"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
DELETE /api/constituents/addresses/{id}¶
Delete Constituent-Address Link
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"constituent": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"address": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"type": "SITE",
"name": "Alvanco Manufacturing Site",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"townCity": "string",
"countyStateRegion": "string",
"postcode": "string",
"country": {
"id": 104,
"name": "string",
"iso3166alpha2CountryCode": "string",
"iso3166alpha3CountryCode": "string"
}
}
}
Schema of the response body
{
"required": [
"address",
"constituent"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"address": {
"$ref": "#/components/schemas/PartyData"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
PATCH /api/constituents/addresses/{id}¶
Partially Update Constituent-Address Link
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"constituent": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"address": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"type": "SITE",
"name": "Alvanco Manufacturing Site",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"townCity": "string",
"countyStateRegion": "string",
"postcode": "string",
"country": {
"id": 169,
"name": "string",
"iso3166alpha2CountryCode": "string",
"iso3166alpha3CountryCode": "string"
}
}
}
Schema of the request body
{
"required": [
"address",
"constituent"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"address": {
"$ref": "#/components/schemas/PartyData"
}
}
}
Response 200 OK
{
"id": 1,
"constituent": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"address": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"type": "SITE",
"name": "Alvanco Manufacturing Site",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"townCity": "string",
"countyStateRegion": "string",
"postcode": "string",
"country": {
"id": 56,
"name": "string",
"iso3166alpha2CountryCode": "string",
"iso3166alpha3CountryCode": "string"
}
}
}
Schema of the response body
{
"required": [
"address",
"constituent"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"address": {
"$ref": "#/components/schemas/PartyData"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
GET /api/constituents/addresses¶
Get all Constituent-Address links
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
constituent |
query | integer | Yes | Filter links by constituent | |
page |
query | integer | 0 | Yes | Zero-based page index (0..N) |
size |
query | integer | 20 | Yes | The size of the page to be returned |
sort |
query | array | Yes | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Response 200 OK
{
"totalPages": 287,
"totalElements": 27,
"size": 174,
"content": [
{
"id": 1,
"constituent": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"address": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"type": "SITE",
"name": "Alvanco Manufacturing Site",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"townCity": "string",
"countyStateRegion": "string",
"postcode": "string",
"country": {
"id": 249,
"name": "string",
"iso3166alpha2CountryCode": "string",
"iso3166alpha3CountryCode": "string"
}
}
}
],
"number": 63,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"pageable": {
"offset": 155,
"sort": null,
"unpaged": true,
"paged": true,
"pageSize": 274,
"pageNumber": 292
},
"numberOfElements": 86,
"first": true,
"last": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConstituentPartyData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
POST /api/constituents/addresses¶
Create new Constituent-Address Link
Request body
{
"id": 1,
"constituent": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"address": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"type": "SITE",
"name": "Alvanco Manufacturing Site",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"townCity": "string",
"countyStateRegion": "string",
"postcode": "string",
"country": {
"id": 20,
"name": "string",
"iso3166alpha2CountryCode": "string",
"iso3166alpha3CountryCode": "string"
}
}
}
Schema of the request body
{
"required": [
"address",
"constituent"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"address": {
"$ref": "#/components/schemas/PartyData"
}
}
}
Response 200 OK
{
"id": 1,
"constituent": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"address": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"type": "SITE",
"name": "Alvanco Manufacturing Site",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"townCity": "string",
"countyStateRegion": "string",
"postcode": "string",
"country": {
"id": 145,
"name": "string",
"iso3166alpha2CountryCode": "string",
"iso3166alpha3CountryCode": "string"
}
}
}
Schema of the response body
{
"required": [
"address",
"constituent"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"constituent": {
"$ref": "#/components/schemas/ConstituentData"
},
"address": {
"$ref": "#/components/schemas/PartyData"
}
}
}
Response 403 Forbidden
Response 400 Bad Request
Response 500 Internal Server Error
Budgets¶
GET /api/budgets/{id}¶
Get a Budget
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Project Delta",
"start": "2025-01-01",
"end": "2027-07-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
{
"required": [
"cost",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"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": "2027-07-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"
}
}
}
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
PUT /api/budgets/{id}¶
Update a Budget
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Project Delta",
"start": "2025-01-01",
"end": "2027-07-03",
"currency": "EUR",
"cost": 20000,
"externalRef": "P0088",
"description": "Budget for our 2025 'Delta' project. Costs to be shared amongst member companies"
}
Schema of the request body
{
"required": [
"cost",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"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": "2027-07-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"
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Project Delta",
"start": "2025-01-01",
"end": "2027-07-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
{
"required": [
"cost",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"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": "2027-07-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"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
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
PATCH /api/budgets/{id}¶
Partially Update a Budget
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Project Delta",
"start": "2025-01-01",
"end": "2027-07-03",
"currency": "EUR",
"cost": 20000,
"externalRef": "P0088",
"description": "Budget for our 2025 'Delta' project. Costs to be shared amongst member companies"
}
Schema of the request body
{
"required": [
"cost",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"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": "2027-07-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"
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Project Delta",
"start": "2025-01-01",
"end": "2027-07-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
{
"required": [
"cost",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"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": "2027-07-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"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
GET /api/budgets¶
Get all Budgets
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
page |
query | integer | 0 | Yes | Zero-based page index (0..N) |
size |
query | integer | 20 | Yes | The size of the page to be returned |
sort |
query | array | Yes | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Response 200 OK
{
"totalPages": 99,
"totalElements": 242,
"size": 134,
"content": [
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Project Delta",
"start": "2025-01-01",
"end": "2027-07-03",
"currency": "EUR",
"cost": 20000,
"externalRef": "P0088",
"description": "Budget for our 2025 'Delta' project. Costs to be shared amongst member companies"
}
],
"number": 91,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"pageable": {
"offset": 8,
"sort": null,
"unpaged": true,
"paged": true,
"pageSize": 79,
"pageNumber": 189
},
"numberOfElements": 61,
"first": true,
"last": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BudgetData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
POST /api/budgets¶
Create a Budget
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Project Delta",
"start": "2025-01-01",
"end": "2027-07-03",
"currency": "EUR",
"cost": 20000,
"externalRef": "P0088",
"description": "Budget for our 2025 'Delta' project. Costs to be shared amongst member companies"
}
Schema of the request body
{
"required": [
"cost",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"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": "2027-07-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"
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Project Delta",
"start": "2025-01-01",
"end": "2027-07-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
{
"required": [
"cost",
"partitionId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"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": "2027-07-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"
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 500 Internal Server Error
Addresses¶
GET /api/addresses/{id}¶
Get an Address
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"type": "SITE",
"name": "Alvanco Manufacturing Site",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"townCity": "string",
"countyStateRegion": "string",
"postcode": "string",
"country": {
"id": 87,
"name": "string",
"iso3166alpha2CountryCode": "string",
"iso3166alpha3CountryCode": "string"
}
}
Schema of the response body
{
"required": [
"addressLine1",
"entity",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"entity": {
"$ref": "#/components/schemas/EntityData"
},
"type": {
"type": "string",
"example": "SITE",
"enum": [
"PRIMARY_ADDRESS",
"BUSINESS_UNIT",
"CONSTITUENT_CONTACT",
"EXTERNAL_CONTACT",
"PRODUCT_CONTACT",
"PURCHASE_MANAGER",
"QUALITY_DIRECTOR",
"REACH_COORDINATOR",
"SITE",
"SUPPLIER",
"SHIP_TO",
"INVOICING_ADDRESS"
]
},
"name": {
"minLength": 1,
"type": "string",
"example": "Alvanco Manufacturing Site"
},
"addressLine1": {
"minLength": 1,
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"townCity": {
"type": "string"
},
"countyStateRegion": {
"type": "string"
},
"postcode": {
"type": "string"
},
"country": {
"$ref": "#/components/schemas/CountryData"
}
}
}
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
PUT /api/addresses/{id}¶
Update an Address
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"type": "SITE",
"name": "Alvanco Manufacturing Site",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"townCity": "string",
"countyStateRegion": "string",
"postcode": "string",
"country": {
"id": 148,
"name": "string",
"iso3166alpha2CountryCode": "string",
"iso3166alpha3CountryCode": "string"
}
}
Schema of the request body
{
"required": [
"addressLine1",
"entity",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"entity": {
"$ref": "#/components/schemas/EntityData"
},
"type": {
"type": "string",
"example": "SITE",
"enum": [
"PRIMARY_ADDRESS",
"BUSINESS_UNIT",
"CONSTITUENT_CONTACT",
"EXTERNAL_CONTACT",
"PRODUCT_CONTACT",
"PURCHASE_MANAGER",
"QUALITY_DIRECTOR",
"REACH_COORDINATOR",
"SITE",
"SUPPLIER",
"SHIP_TO",
"INVOICING_ADDRESS"
]
},
"name": {
"minLength": 1,
"type": "string",
"example": "Alvanco Manufacturing Site"
},
"addressLine1": {
"minLength": 1,
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"townCity": {
"type": "string"
},
"countyStateRegion": {
"type": "string"
},
"postcode": {
"type": "string"
},
"country": {
"$ref": "#/components/schemas/CountryData"
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"type": "SITE",
"name": "Alvanco Manufacturing Site",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"townCity": "string",
"countyStateRegion": "string",
"postcode": "string",
"country": {
"id": 296,
"name": "string",
"iso3166alpha2CountryCode": "string",
"iso3166alpha3CountryCode": "string"
}
}
Schema of the response body
{
"required": [
"addressLine1",
"entity",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"entity": {
"$ref": "#/components/schemas/EntityData"
},
"type": {
"type": "string",
"example": "SITE",
"enum": [
"PRIMARY_ADDRESS",
"BUSINESS_UNIT",
"CONSTITUENT_CONTACT",
"EXTERNAL_CONTACT",
"PRODUCT_CONTACT",
"PURCHASE_MANAGER",
"QUALITY_DIRECTOR",
"REACH_COORDINATOR",
"SITE",
"SUPPLIER",
"SHIP_TO",
"INVOICING_ADDRESS"
]
},
"name": {
"minLength": 1,
"type": "string",
"example": "Alvanco Manufacturing Site"
},
"addressLine1": {
"minLength": 1,
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"townCity": {
"type": "string"
},
"countyStateRegion": {
"type": "string"
},
"postcode": {
"type": "string"
},
"country": {
"$ref": "#/components/schemas/CountryData"
}
}
}
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
PATCH /api/addresses/{id}¶
Partially Update an Address
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"type": "SITE",
"name": "Alvanco Manufacturing Site",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"townCity": "string",
"countyStateRegion": "string",
"postcode": "string",
"country": {
"id": 217,
"name": "string",
"iso3166alpha2CountryCode": "string",
"iso3166alpha3CountryCode": "string"
}
}
Schema of the request body
{
"required": [
"addressLine1",
"entity",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"entity": {
"$ref": "#/components/schemas/EntityData"
},
"type": {
"type": "string",
"example": "SITE",
"enum": [
"PRIMARY_ADDRESS",
"BUSINESS_UNIT",
"CONSTITUENT_CONTACT",
"EXTERNAL_CONTACT",
"PRODUCT_CONTACT",
"PURCHASE_MANAGER",
"QUALITY_DIRECTOR",
"REACH_COORDINATOR",
"SITE",
"SUPPLIER",
"SHIP_TO",
"INVOICING_ADDRESS"
]
},
"name": {
"minLength": 1,
"type": "string",
"example": "Alvanco Manufacturing Site"
},
"addressLine1": {
"minLength": 1,
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"townCity": {
"type": "string"
},
"countyStateRegion": {
"type": "string"
},
"postcode": {
"type": "string"
},
"country": {
"$ref": "#/components/schemas/CountryData"
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"type": "SITE",
"name": "Alvanco Manufacturing Site",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"townCity": "string",
"countyStateRegion": "string",
"postcode": "string",
"country": {
"id": 182,
"name": "string",
"iso3166alpha2CountryCode": "string",
"iso3166alpha3CountryCode": "string"
}
}
Schema of the response body
{
"required": [
"addressLine1",
"entity",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"entity": {
"$ref": "#/components/schemas/EntityData"
},
"type": {
"type": "string",
"example": "SITE",
"enum": [
"PRIMARY_ADDRESS",
"BUSINESS_UNIT",
"CONSTITUENT_CONTACT",
"EXTERNAL_CONTACT",
"PRODUCT_CONTACT",
"PURCHASE_MANAGER",
"QUALITY_DIRECTOR",
"REACH_COORDINATOR",
"SITE",
"SUPPLIER",
"SHIP_TO",
"INVOICING_ADDRESS"
]
},
"name": {
"minLength": 1,
"type": "string",
"example": "Alvanco Manufacturing Site"
},
"addressLine1": {
"minLength": 1,
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"townCity": {
"type": "string"
},
"countyStateRegion": {
"type": "string"
},
"postcode": {
"type": "string"
},
"country": {
"$ref": "#/components/schemas/CountryData"
}
}
}
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
GET /api/addresses¶
Get Addresses
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
constituent |
query | integer | Yes | Filter addresses by constituent | |
contact |
query | integer | Yes | Filter addresses by contact | |
entity |
query | integer | Yes | Filter addresses by entity | |
page |
query | integer | 0 | Yes | Zero-based page index (0..N) |
product |
query | integer | Yes | Filter addresses by product | |
size |
query | integer | 20 | Yes | The size of the page to be returned |
sort |
query | array | Yes | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Response 200 OK
{
"totalPages": 37,
"totalElements": 154,
"size": 179,
"content": [
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"type": "SITE",
"name": "Alvanco Manufacturing Site",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"townCity": "string",
"countyStateRegion": "string",
"postcode": "string",
"country": {
"id": 259,
"name": "string",
"iso3166alpha2CountryCode": "string",
"iso3166alpha3CountryCode": "string"
}
}
],
"number": 220,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"pageable": {
"offset": 215,
"sort": null,
"unpaged": true,
"paged": true,
"pageSize": 90,
"pageNumber": 15
},
"numberOfElements": 57,
"first": true,
"last": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PartyData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
POST /api/addresses¶
Create Address
Request body
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"type": "SITE",
"name": "Alvanco Manufacturing Site",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"townCity": "string",
"countyStateRegion": "string",
"postcode": "string",
"country": {
"id": 158,
"name": "string",
"iso3166alpha2CountryCode": "string",
"iso3166alpha3CountryCode": "string"
}
}
Schema of the request body
{
"required": [
"addressLine1",
"entity",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"entity": {
"$ref": "#/components/schemas/EntityData"
},
"type": {
"type": "string",
"example": "SITE",
"enum": [
"PRIMARY_ADDRESS",
"BUSINESS_UNIT",
"CONSTITUENT_CONTACT",
"EXTERNAL_CONTACT",
"PRODUCT_CONTACT",
"PURCHASE_MANAGER",
"QUALITY_DIRECTOR",
"REACH_COORDINATOR",
"SITE",
"SUPPLIER",
"SHIP_TO",
"INVOICING_ADDRESS"
]
},
"name": {
"minLength": 1,
"type": "string",
"example": "Alvanco Manufacturing Site"
},
"addressLine1": {
"minLength": 1,
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"townCity": {
"type": "string"
},
"countyStateRegion": {
"type": "string"
},
"postcode": {
"type": "string"
},
"country": {
"$ref": "#/components/schemas/CountryData"
}
}
}
Response 200 OK
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"type": "SITE",
"name": "Alvanco Manufacturing Site",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"townCity": "string",
"countyStateRegion": "string",
"postcode": "string",
"country": {
"id": 281,
"name": "string",
"iso3166alpha2CountryCode": "string",
"iso3166alpha3CountryCode": "string"
}
}
Schema of the response body
{
"required": [
"addressLine1",
"entity",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"createdBy": {
"$ref": "#/components/schemas/UserData"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"$ref": "#/components/schemas/UserData"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"entity": {
"$ref": "#/components/schemas/EntityData"
},
"type": {
"type": "string",
"example": "SITE",
"enum": [
"PRIMARY_ADDRESS",
"BUSINESS_UNIT",
"CONSTITUENT_CONTACT",
"EXTERNAL_CONTACT",
"PRODUCT_CONTACT",
"PURCHASE_MANAGER",
"QUALITY_DIRECTOR",
"REACH_COORDINATOR",
"SITE",
"SUPPLIER",
"SHIP_TO",
"INVOICING_ADDRESS"
]
},
"name": {
"minLength": 1,
"type": "string",
"example": "Alvanco Manufacturing Site"
},
"addressLine1": {
"minLength": 1,
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"townCity": {
"type": "string"
},
"countyStateRegion": {
"type": "string"
},
"postcode": {
"type": "string"
},
"country": {
"$ref": "#/components/schemas/CountryData"
}
}
}
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
Users¶
POST /api/users/{id}/send-login-details¶
Send a user their login details
Description
Resets the user's password to a new temporary one, which they must change when they next log in, and emails it to them with their username (the Mailjet welcome email). Each call issues a new temporary password. Not possible for a user whose account is managed by an identity provider (SCIM). The email doesn't depend on the partition: a user of any partition will do, or for a logged-in caller, a user of their current partition
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No | Id of the user |
Response 200 OK
{
"userId": 321,
"email": "jane.smith@example.com"
}
Schema of the response body
{
"type": "object",
"properties": {
"userId": {
"type": "integer",
"description": "Id of the user",
"format": "int64",
"example": 321
},
"email": {
"type": "string",
"description": "The address the login details were sent to",
"example": "jane.smith@example.com"
}
}
}
Response 403 Forbidden
Response 404 Not Found
Response 409 Conflict
Response 502 Bad Gateway
Response 500 Internal Server Error
IPLICIT Integration¶
POST /api/invoices/iplicit/sync¶
Sync invoices from IPLICIT
Description
Imports invoices from IPLICIT into the partition, creating or updating the matching invoice documents (amounts, entity links, cost allocations, PDF and payment status), exactly as the invoice import in the application does.
Partition: optional. With an X-API-KEY and no partitionId, every
partition's IPLICIT integration is synced; with ?partitionId= only that
partition's. A logged-in user syncs their current partition.
Filters use AND logic: when both invoiceNumbers and clientId are
provided, only invoices matching the given numbers AND belonging to the
given client are synced. At least one filter is required.
Precondition (IPLICIT): an invoice must be posted in IPLICIT before it
can be imported, as its PDF is only available once posted. Unposted invoices
are reported as FAILED.
Outcomes (per invoice): CREATED, UPDATED, UNCHANGED (already
matched IPLICIT; nothing saved), NOT_FOUND (requested number not returned
by IPLICIT), FAILED (see message).
Safe to retry: syncing the same invoice again is a no-op reported as
UNCHANGED - no duplicate document is created and no second 'paid'
notification is sent.
Payment status: when an invoice is paid in IPLICIT, the sync sets
paymentReceived / outstandingAmount and paymentReceivedDate, visible
on GET /api/documents/{id} using the returned documentId. The not-paid
to paid transition sends the usual 'paid' notification.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
partitionId |
query | integer | Yes | Only sync this partition's IPLICIT integration. With an X-API-KEY, omit it to sync every partition's; a logged-in user only ever syncs their current partition |
Request body
{
"invoiceNumbers": [
"INV-001",
"INV-002",
"INV-003"
],
"clientId": null
}
{
"invoiceNumbers": null,
"clientId": "PCLTD1613"
}
Schema of the request body
{
"type": "object",
"properties": {
"invoiceNumbers": {
"type": "array",
"description": "List of specific invoice numbers to sync. Use this to fetch individual invoices by their reference numbers.",
"nullable": true,
"example": [
"INV-001",
"INV-002",
"INV-003"
],
"items": {
"type": "string",
"description": "List of specific invoice numbers to sync. Use this to fetch individual invoices by their reference numbers.",
"nullable": true,
"example": "[\"INV-001\",\"INV-002\",\"INV-003\"]"
}
},
"clientId": {
"type": "string",
"description": "Client ID (can be ContactAccount Code, IntRef, or GUID). Use this to fetch all invoices for a specific customer or supplier.",
"nullable": true,
"example": "PCLTD1613"
}
},
"description": "Request object for filtering and synchronizing IPLICIT invoices"
}
Response 200 OK
{
"syncedCount": 2,
"invoices": [
{
"invoiceNumber": "INV-001",
"outcome": "CREATED",
"documentId": 123,
"message": null
},
{
"invoiceNumber": "INV-002",
"outcome": "UNCHANGED",
"documentId": 98,
"message": null
},
{
"invoiceNumber": "INV-003",
"outcome": "FAILED",
"documentId": null,
"message": "No PDF could be read 'INV-003'. The invoice must be posted in iplicit before its PDF can be imported"
},
{
"invoiceNumber": "INV-004",
"outcome": "NOT_FOUND",
"documentId": null,
"message": "No invoice found in iplicit with this number"
}
]
}
Schema of the response body
{
"type": "object",
"properties": {
"syncedCount": {
"type": "integer",
"description": "Number of invoices now in sync with IPLICIT (CREATED, UPDATED or UNCHANGED)",
"format": "int32",
"example": 2
},
"invoices": {
"type": "array",
"description": "Per-invoice outcome. Requested invoice numbers that IPLICIT did not return are reported as NOT_FOUND",
"items": {
"$ref": "#/components/schemas/IplicitInvoiceSyncResult"
}
}
},
"description": "Response object for filtering and synchronizing IPLICIT invoices"
}
Response 400 Bad Request
"At least one filter must be provided: invoiceNumbers, clientId"
Schema of the response body
Response 403 Forbidden
Response 502 Bad Gateway
"Error fetching invoices from iplicit: 503 Service Unavailable"
Schema of the response body
Emails¶
POST /api/emails¶
Send a template email to contacts
Description
Sends the template email (GET /api/email-templates) exactly as the email wizard would - via Mailjet or over SMTP, as the template says - with the documents given attached, and saves it in Documents, linked to the recipients and their companies, and to the company, constituents and campaign given. Of the template, recipients, campaign, company, constituents and documents only the id is read. Given a campaign, the send is recorded on it. An INVOICE template sends the one invoice in 'documents' as Invoices Overview → Send does: filled in from the invoice, its PDF attached, by default to its 'To' company's invoicing contacts, in the invoice's partition. The invoice is recorded as sent (sent, sentDate, sentBy) as soon as the email is queued; it is delivered over SMTP in the background. An invoice already sent gets 409 unless 'resend' is true. Supply a 'dedupeKey' to make a retry safe: the key is claimed before sending, so a retry or a concurrent call with it gets 409. A key is freed again only when the request failed before any email went out. Over SMTP, an email the server fails to send is left unsent in the outbox. The email is sent in the partition of the campaign, else of the template (if it belongs to one partition), else of the first recipient; the other records must be in the same partition (for a logged-in user, their current partition). A dedupeKey is unique within the partition
Request body
{
"template": {
"id": "jsgRegistrantConfirmation",
"name": "JSG Registrant Confirmation",
"description": "Confirms to a client that they are now a JSG registrant",
"kind": "GENERAL",
"partitionId": 101,
"transport": "MAILJET",
"emailType": "SINGLE",
"mergeVariables": [
"todayDate",
"partitionName",
"firstName",
"lastName"
]
},
"recipients": [
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false,
"lastLoggedIn": "2022-04-13T15:42:05.901Z"
}
],
"cc": [
"registrations@example.com"
],
"campaign": {
"id": 12,
"name": "Calcium dihydroxide JSG",
"partitionId": 101,
"description": "Joint submission group portal for calcium dihydroxide",
"startDate": "2025-01-01",
"endDate": "2030-12-31",
"archived": false
},
"taskGroupIds": [
3
],
"entity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"constituents": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
}
],
"documents": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "2025-31-01 Benzene CSR",
"type": "CSR",
"documentCreationDate": "2027-07-01",
"invoiceDate": "2025-07-11",
"sentViaEmail": false,
"toEntity": null,
"fromEntity": null,
"invoiceType": "Commercial",
"invoiceNumber": "1234",
"currency": "EUR",
"subTotal": 100.0,
"total": 150.0,
"outstandingAmount": 10.12,
"paymentReceivedDate": "2025-07-11",
"paymentApproved": false,
"paymentApprovedDate": "2025-07-11",
"paymentApprovedBy": null,
"paymentSent": false,
"paymentSentDate": "2025-07-11",
"paymentSentBy": null,
"legislation": "EU_REACH",
"vat": 10.0,
"purchaseOrder": "PO123",
"accountantReference": "SI/23/25",
"contractType": "LETTER_OF_ACCESS",
"contractDate": "2026-10-01",
"tonnageBand": "BAND_1",
"constituents": null,
"products": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
}
],
"entities": null,
"cost": 1500.0,
"fee": 150.0,
"paymentReceived": true
}
],
"variables": {
"jsgName": "Benzene JSG"
},
"resend": true,
"dedupeKey": "loa-2026-0042-registrant-confirmation"
}
Schema of the request body
{
"required": [
"template"
],
"type": "object",
"properties": {
"template": {
"$ref": "#/components/schemas/EmailTemplateData"
},
"recipients": {
"type": "array",
"description": "The contacts to send the email to: only each contact's id is read. Required, except with an INVOICE template, which defaults to the invoicing contacts of the invoice's 'To' company",
"items": {
"$ref": "#/components/schemas/ContactData"
}
},
"cc": {
"type": "array",
"description": "Other addresses to copy the email to. On a Mailjet template they are sent the email and recorded as BCC (as the wizard's 'other recipients'); on an SMTP template they are CC'd",
"example": [
"registrations@example.com"
],
"items": {
"type": "string",
"description": "Other addresses to copy the email to. On a Mailjet template they are sent the email and recorded as BCC (as the wizard's 'other recipients'); on an SMTP template they are CC'd",
"example": "[\"registrations@example.com\"]"
}
},
"campaign": {
"$ref": "#/components/schemas/Campaign"
},
"taskGroupIds": {
"type": "array",
"description": "INVOICE template only, with a 'campaign': the campaign's task groups (tabs) to show the download task in",
"example": [
3
],
"items": {
"type": "integer",
"description": "INVOICE template only, with a 'campaign': the campaign's task groups (tabs) to show the download task in",
"format": "int64"
}
},
"entity": {
"$ref": "#/components/schemas/EntityData"
},
"constituents": {
"type": "array",
"description": "Constituents to link the email to: only each constituent's id is read. Not for an INVOICE template",
"items": {
"$ref": "#/components/schemas/ConstituentData"
}
},
"documents": {
"type": "array",
"description": "Documents to attach to the email, which is also linked to them (an email document is attached as HTML). Each must be a file in the email's partition, within the attachment size limit and not still being generated. Needs ROLE_DOCUMENT_VIEW. With an INVOICE template, give exactly one: the invoice, which must have its PDF. Only each document's id is read",
"items": {
"$ref": "#/components/schemas/DocumentData"
}
},
"variables": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "Extra template variables. They never replace the template's own (see 'mergeVariables'). Not for an INVOICE template, which is filled in from the invoice",
"example": {
"jsgName": "Benzene JSG"
}
},
"description": "Extra template variables. They never replace the template's own (see 'mergeVariables'). Not for an INVOICE template, which is filled in from the invoice",
"example": {
"jsgName": "Benzene JSG"
}
},
"resend": {
"type": "boolean",
"description": "INVOICE template only: send the invoice although it was already sent (otherwise 409)"
},
"dedupeKey": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "Optional key making the request safe to retry: sending again with a key already used in the partition returns 409 with the id of the email sent the first time",
"example": "loa-2026-0042-registrant-confirmation"
}
}
}
Response 200 OK
{
"id": 98765,
"emails": [
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "2025-31-01 Benzene CSR",
"type": "CSR",
"documentCreationDate": "2027-07-01",
"invoiceDate": "2025-07-11",
"sentViaEmail": false,
"toEntity": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Penman Consulting",
"companyNo": "string",
"vatNo": "string",
"dunnNo": "string",
"utr": "string",
"invoiceRef": "PENMAN_212REF",
"reachUuid": "ECHA-3f2a1b4c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
"archived": false
},
"fromEntity": null,
"invoiceType": "Commercial",
"invoiceNumber": "1234",
"currency": "EUR",
"subTotal": 100.0,
"total": 150.0,
"outstandingAmount": 10.12,
"paymentReceivedDate": "2025-07-11",
"paymentApproved": false,
"paymentApprovedDate": "2025-07-11",
"paymentApprovedBy": null,
"paymentSent": false,
"paymentSentDate": "2025-07-11",
"paymentSentBy": null,
"legislation": "EU_REACH",
"vat": 10.0,
"purchaseOrder": "PO123",
"accountantReference": "SI/23/25",
"contractType": "LETTER_OF_ACCESS",
"contractDate": "2026-10-01",
"tonnageBand": "BAND_1",
"constituents": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
}
],
"products": [
{
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
}
],
"entities": null,
"cost": 1500.0,
"fee": 150.0,
"paymentReceived": true
}
],
"transport": "MAILJET",
"skippedEmails": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Id of the email document saved in Documents (the first, where one was saved per recipient)",
"format": "int64",
"example": 98765
},
"emails": {
"type": "array",
"description": "Every email document saved (GET /api/documents/{id}): one per recipient for a SINGLE template. Only each document's id is given",
"items": {
"$ref": "#/components/schemas/DocumentData"
}
},
"transport": {
"type": "string",
"enum": [
"MAILJET",
"SMTP"
]
},
"skippedEmails": {
"type": "array",
"description": "Addresses the email was not sent to, because they are blacklisted",
"items": {
"type": "string",
"description": "Addresses the email was not sent to, because they are blacklisted"
}
}
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 404 Not Found
Response 409 Conflict
{
"message": "An email has already been sent with dedupeKey 'loa-42'",
"existingId": 98765
}
Schema of the response body
Response 502 Bad Gateway
Response 500 Internal Server Error
GET /api/email-templates¶
Get the email templates
Description
The templates POST /api/emails can send, by name, each with its 'kind' (the invoice email templates too): those of a logged-in user's current partition, and those every partition shares; with an X-API-KEY, those of the 'partitionId' given, else of every partition
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
partitionId |
query | integer | Yes | Only records in this partition. Omit it for all partitions |
Response 200 OK
[
{
"id": "jsgRegistrantConfirmation",
"name": "JSG Registrant Confirmation",
"description": "Confirms to a client that they are now a JSG registrant",
"kind": "GENERAL",
"partitionId": 101,
"transport": "MAILJET",
"emailType": "SINGLE",
"mergeVariables": [
"todayDate",
"partitionName",
"firstName",
"lastName"
]
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailTemplateData"
}
}
Response 400 Bad Request
Response 403 Forbidden
Response 500 Internal Server Error
Study Types¶
GET /api/study-types¶
Get all Study Types
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
page |
query | integer | 0 | Yes | Zero-based page index (0..N) |
size |
query | integer | 20 | Yes | The size of the page to be returned |
sort |
query | array | Yes | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | |
study |
query | integer | Yes | Filter Study Types by Study |
Response 200 OK
{
"totalPages": 18,
"totalElements": 259,
"size": 202,
"content": [
{
"id": 28,
"description": "BS 188 (Methods for determination of the viscocity of liquids)"
}
],
"number": 51,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"pageable": {
"offset": 120,
"sort": null,
"unpaged": true,
"paged": true,
"pageSize": 124,
"pageNumber": 240
},
"numberOfElements": 186,
"first": true,
"last": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StudyTypeData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
Response 403 Forbidden
{
"totalPages": 55,
"totalElements": 260,
"size": 42,
"content": [
{
"id": 131,
"description": "BS 188 (Methods for determination of the viscocity of liquids)"
}
],
"number": 113,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"pageable": {
"offset": 91,
"sort": null,
"unpaged": true,
"paged": true,
"pageSize": 105,
"pageNumber": 14
},
"numberOfElements": 1,
"first": true,
"last": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StudyTypeData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
GET /api/study-types/{id}¶
Get a Study Type
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 150,
"description": "BS 188 (Methods for determination of the viscocity of liquids)"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string",
"example": "BS 188 (Methods for determination of the viscocity of liquids)"
}
}
}
Response 403 Forbidden
{
"id": 256,
"description": "BS 188 (Methods for determination of the viscocity of liquids)"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string",
"example": "BS 188 (Methods for determination of the viscocity of liquids)"
}
}
}
Search¶
GET /api/search¶
Search across constituents, products, entities, studies and documents
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entityType |
query | string | Yes | Restrict results to a single entity type (e.g. 'study', 'document') | |
fields |
query | array | Yes | Restrict search to specific fields | |
page |
query | integer | 0 | Yes | Zero-based page index (0..N) |
partition |
query | integer | Yes | Partition ID to scope the search | |
size |
query | integer | 20 | Yes | The size of the page to be returned |
term |
query | string | No | Search term |
Response 200 OK
{
"totalPages": 89,
"totalElements": 169,
"size": 127,
"content": [
{
"id": 1,
"partitionId": 100,
"name": "Benzene Safety Data Sheet",
"entityType": "document",
"score": 11000.98
}
],
"number": 24,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"pageable": {
"offset": 168,
"sort": null,
"unpaged": true,
"paged": true,
"pageSize": 227,
"pageNumber": 67
},
"numberOfElements": 138,
"first": true,
"last": true,
"empty": true
}
Schema of the response body
{
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearchResultData"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
Response 400 Bad Request
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",
"accessType": "RESTRICTED"
}
]
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",
"accessType": "RESTRICTED"
}
Schema of the response body
{
"required": [
"accessType",
"email",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"name": {
"minLength": 1,
"type": "string",
"example": "Sandbox"
},
"email": {
"minLength": 1,
"type": "string",
"example": "sandbox@demo.activesteward.com"
},
"accessType": {
"type": "string",
"description": "Controls how users can discover and join the partition.",
"example": "RESTRICTED",
"enum": [
"PUBLIC",
"RESTRICTED",
"PRIVATE"
]
}
}
}
Response 403 Forbidden
Response 404 Not Found
Response 500 Internal Server Error
Composition Item Types¶
GET /api/constituent-types¶
Get all Composition Item Types, in menu order
Response 200 OK
[
{
"id": 237,
"code": "SUBSTANCE",
"name": "Substance",
"composite": true,
"icon": "flask"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ConstituentTypeData"
}
}
Response 403 Forbidden
[
{
"id": 276,
"code": "SUBSTANCE",
"name": "Substance",
"composite": true,
"icon": "flask"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ConstituentTypeData"
}
}
GET /api/constituent-types/{id}¶
Get a Composition Item Type
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | integer | No |
Response 200 OK
{
"id": 7,
"code": "SUBSTANCE",
"name": "Substance",
"composite": true,
"icon": "flask"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"code": {
"type": "string",
"description": "Stable identifier; the value accepted as a composition item's type",
"example": "SUBSTANCE"
},
"name": {
"type": "string",
"example": "Substance"
},
"composite": {
"type": "boolean",
"description": "True if items of this type are made of other composition items"
},
"icon": {
"type": "string",
"description": "Font Awesome icon slug, null when the type uses its own SVG icon",
"example": "flask"
}
}
}
Response 403 Forbidden
{
"id": 54,
"code": "SUBSTANCE",
"name": "Substance",
"composite": true,
"icon": "flask"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"code": {
"type": "string",
"description": "Stable identifier; the value accepted as a composition item's type",
"example": "SUBSTANCE"
},
"name": {
"type": "string",
"example": "Substance"
},
"composite": {
"type": "boolean",
"description": "True if items of this type are made of other composition items"
},
"icon": {
"type": "string",
"description": "Font Awesome icon slug, null when the type uses its own SVG icon",
"example": "flask"
}
}
}
Response 404 Not Found
{
"id": 132,
"code": "SUBSTANCE",
"name": "Substance",
"composite": true,
"icon": "flask"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"code": {
"type": "string",
"description": "Stable identifier; the value accepted as a composition item's type",
"example": "SUBSTANCE"
},
"name": {
"type": "string",
"example": "Substance"
},
"composite": {
"type": "boolean",
"description": "True if items of this type are made of other composition items"
},
"icon": {
"type": "string",
"description": "Font Awesome icon slug, null when the type uses its own SVG icon",
"example": "flask"
}
}
}
Compositions¶
GET /api/compositions¶
Compositions
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
constituent |
query | integer | Yes | ||
product |
query | integer | Yes |
Response 200 OK
[
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/CompositionData"
}
}
GET /api/compositions/versions¶
Get Composition Versions
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
composition |
query | integer | Yes | ||
constituent |
query | integer | Yes |
Response 200 OK
[
{
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"composition": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
},
"formulation": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": null,
"constituent": null,
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
},
"number": 244,
"start": "2022-04-13",
"end": "2022-04-13",
"remarks": "string",
"current": true
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/CompositeVersionData"
}
}
Formulations & Compositions¶
GET /api/composites/versions/proportions¶
Get the proportions of a constituent/product
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
constituent |
query | integer | Yes | ||
product |
query | integer | Yes | ||
version |
query | integer | Yes |
Response 200 OK
[
{
"id": 1,
"percentage": 3.85,
"parentVersion": {
"id": 1,
"createdBy": {
"id": 1,
"firstName": "Bob",
"lastName": "Ross",
"emailAddress": "bob.ross@penmanconsulting.com"
},
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"composition": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"partitionId": 100,
"name": "Lubricant",
"ownerManufacturer": "Penman Consulting",
"archived": false
},
"constituent": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"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",
"archived": false
},
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
},
"formulation": {
"id": 1,
"createdBy": null,
"created": "2022-04-13T15:42:05.901Z",
"lastUpdatedBy": null,
"lastUpdated": "2022-04-13T15:42:05.901Z",
"product": null,
"constituent": null,
"identifier": "string",
"remarks": "string",
"type": {
"id": 1,
"name": "string"
}
},
"number": 203,
"start": "2022-04-13",
"end": "2022-04-13",
"remarks": "string",
"current": true
},
"childConstituent": null,
"childVersion": null,
"childName": "string",
"name": "string",
"display": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/CompositeProportionData"
}
}
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 |
notes |
string |
origin |
Party |
preparation |
string(date) |
referenceNumber |
string |
studies |
Array<Study> |
studyBeingEditedOrImported |
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 |
carbonNumber |
integer(int32) |
casNumber |
string |
ecNumber |
string |
exportIndex |
integer(int32) |
id |
integer(int64) |
inclusionPercent |
number(double) |
name |
string |
type |
Array<AnalyticalSampleOrderedSubConstituentTypeReference> |
typeText |
string |
AnalyticalSampleSubConstituentType¶
| Name | Type |
|---|---|
id |
integer(int64) |
typeText |
string |
BaseEntity¶
| Name | Type |
|---|---|
clientPartitionId |
integer(int64) |
companyNo |
string |
consortiumMember |
boolean |
created |
string(date-time) |
createdBy |
User |
deleted |
boolean |
dunnNo |
string |
groups |
Array<EntityGroup> |
hasInvoicingAddress |
boolean |
id |
integer(int64) |
invoiceOverdueDays |
integer(int64) |
invoicingReference |
string |
lastUpdated |
string(date-time) |
name |
string |
partitionId |
integer(int64) |
poNumber |
string |
primaryInvoicingContact |
Contact |
primaryInvoicingContactToImport |
string |
reachID |
string |
registrationsFor |
Array<ReachRegistration> |
registrationsSubmitter |
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 |
|---|---|
additionalShare |
integer(int32) |
additionalShareDecimal |
number |
breadcrumbParent |
Displayable |
budgetType |
string |
categoryGroups |
Array<CategoryGroup> |
clientPartition |
ClientPartition |
commentDisplayUrl |
string |
comments |
Array<BudgetComment> |
commentsEditPermission |
string |
commentsPermission |
string |
commentType |
string |
constituents |
Array<Constituent> |
constituentsFallback |
Array<Constituent> |
cost |
number |
costsShared |
boolean |
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 |
end |
string(date) |
entities |
Array<BaseEntity> |
entityBudgets |
Array<EntityBudget> |
externalRef |
string |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
invoices |
Array<DocumentInvoice> |
lastUpdated |
string(date-time) |
lastUpdatedById |
integer(int64) |
name |
string |
pages |
Array<CampaignPage> |
partition |
ClientPartition |
partitionId |
integer(int64) |
products |
Array<Product> |
recordName |
string |
start |
string(date) |
type |
string |
url |
string |
watchers |
Array<User> |
watching |
boolean |
watchingUsers |
Array<User> |
BudgetComment¶
| Name | Type |
|---|---|
allDay |
boolean |
breadcrumbParent |
Displayable |
calendarEnd |
string(date-time) |
calendarExtendedProps |
|
calendarSource |
string |
contact |
Contact |
created |
string(date-time) |
createdBy |
User |
createdDate |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
hidden |
boolean |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
User |
lastUpdatedById |
integer(int64) |
name |
string |
partition |
ClientPartition |
published |
boolean |
ragStatus |
string |
recordName |
string |
replies |
Array<Comment> |
reply |
boolean |
replyTo |
Comment |
replyToIsUnpublished |
boolean |
serverCreatedReadableDate |
string |
text |
string |
user |
User |
BudgetData¶
| Name | Type |
|---|---|
cost |
number |
created |
string(date-time) |
createdBy |
UserData |
currency |
string |
description |
string |
end |
string(date) |
externalRef |
string |
id |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
UserData |
name |
string |
partitionId |
integer(int64) |
start |
string(date) |
Campaign¶
| Name | Type |
|---|---|
archived |
boolean |
description |
string |
endDate |
string(date) |
id |
integer(int64) |
name |
string |
partitionId |
integer(int64) |
startDate |
string(date) |
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 |
partition |
ClientPartition |
partitionId |
integer(int64) |
recordName |
string |
roles |
Array<CampaignRole> |
url |
string |
user |
User |
userCreated |
boolean |
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)> |
downloadedDocuments |
Array<Document> |
downloadedOldDocumentsOf |
Array<integer(int64)> |
eventDate |
string(date-time) |
fileId |
string(uuid) |
fileName |
string |
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 |
activeDownload |
Document |
activeIuclidDownload |
DocumentIUCLIDOutput |
allowDownload |
boolean |
allUsers |
boolean |
annexes |
Array<string> |
archived |
boolean |
associatedAccessDisplay |
string |
associatedContacts |
Array<Contact> |
associatedRecord |
Displayable |
association |
string |
associationRestricted |
boolean |
breadcrumbParent |
Displayable |
campaign |
Campaign |
campaignIfUnrestricted |
Campaign |
categoryGroup |
CategoryGroup |
clientPartition |
ClientPartition |
closed |
boolean |
closesOnDate |
string(date) |
commentDisplayUrl |
string |
comments |
Array<CampaignTaskComment> |
commentsEditPermission |
string |
commentsPermission |
string |
commentType |
string |
constituent |
Constituent |
contact |
Contact |
contactGroup |
ContactGroup |
contactGroupRestrictionDisplay |
string |
contactGroupRole |
string |
containingArchivedDocument |
boolean |
createdDate |
string(date-time) |
createdLocalDate |
string(date) |
deleted |
boolean |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
document |
Document |
documentTwo |
Document |
dueByDate |
string(date) |
endingInstructions |
string |
endingInstructionsIssues |
Array<SecurityIssue> |
entity |
BaseEntity |
entityGroup |
EntityGroup |
entityRoles |
Array<EntityRole> |
events |
Array<CampaignContactEvent> |
forYear |
integer(int32) |
groups |
Array<CampaignContactTaskGroup> |
hidden |
boolean |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
instructions |
string |
instructionsIssues |
Array<SecurityIssue> |
iuclidReviewNotifications |
Array<NotificationIuclidReview> |
legislations |
Array<string> |
letterOfAccessRelated |
boolean |
name |
string |
openToSignedIn |
boolean |
pages |
Array<CampaignPage> |
partition |
ClientPartition |
partitionId |
integer(int64) |
public |
boolean |
recordName |
string |
registrationRoles |
Array<string> |
relationshipCriteriaDisplay |
string |
restrictedToAssociations |
boolean |
restrictedToCompanies |
boolean |
restrictedToConstituent |
boolean |
restrictedToContactGroup |
boolean |
role |
CampaignRole |
sendCustomSurveyNotificationEmail |
boolean |
showDocumentNameOnDownloads |
boolean |
surveyFields |
Array<SurveyField> |
surveyNotifications |
Array<NotificationCampaignSurvey> |
surveyRoles |
Array<string> |
taskGroupLinks |
Array<TaskGroupTask> |
taskType |
string |
template |
CampaignTaskTemplate |
uploadNotificationEmail |
string |
uploadNotifications |
Array<NotificationCampaignUpload> |
url |
string |
user |
User |
uses |
Array<string(uuid)> |
watchers |
Array<User> |
watching |
boolean |
watchingUsers |
Array<User> |
webPortalDisplay |
string |
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 |
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 |
accessibleToDisplay |
string |
activeEntities |
Array<BaseEntity> |
allFields |
string |
allUsers |
boolean |
ancestorsString |
string |
annexes |
Array<string> |
archived |
boolean |
associatedAccessDisplay |
string |
associatedRecord |
Displayable |
associatedToArchivedContact |
boolean |
association |
string |
associationRestricted |
boolean |
campaignNavigationLevel |
integer(int32) |
caretPosition |
string |
categoryGroup |
CategoryGroup |
clientPartition |
ClientPartition |
config |
DisplayConfig |
constituent |
Constituent |
constituentFallback |
Constituent |
contactGroup |
ContactGroup |
contactGroupRestrictionDisplay |
string |
contactGroupRole |
string |
contactInformation |
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 |
entityRoles |
Array<EntityRole> |
expand |
boolean |
hidden |
boolean |
hideDownloadedColumn |
boolean |
highestSection |
CampaignSection |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
index |
integer(int32) |
issues |
Array<SecurityIssue> |
lastUpdated |
string(date-time) |
lastUpdatedById |
integer(int64) |
legislations |
Array<string> |
membersUrl |
string |
membersUrlNewUi |
string |
menuAncestors |
Array<CampaignMenuDisplayable> |
menuIndex |
integer(int32) |
menuParent |
CampaignMenuDisplayable |
name |
string |
nameWithSections |
string |
notifications |
Array<NotificationPageChange> |
openToSignedIn |
boolean |
partition |
ClientPartition |
partitionId |
integer(int64) |
public |
boolean |
recordName |
string |
registrationRoles |
Array<string> |
relationshipCriteriaDisplay |
string |
restrictedToAssociations |
boolean |
restrictedToCompanies |
boolean |
restrictedToConstituent |
boolean |
restrictedToContactGroup |
boolean |
roles |
Array<CampaignRole> |
sections |
Array<CampaignSection> |
source |
string |
tags |
Array<Tag> |
task |
CampaignContactTask |
type |
string |
url |
string |
visible |
boolean |
visibleToDeactivated |
boolean |
CampaignPageTaskGroup¶
| Name | Type |
|---|---|
cutOffDate |
string(date) |
id |
integer(int64) |
index |
integer(int32) |
page |
CampaignPage |
taskGroup |
CampaignContactTaskGroup |
CampaignRole¶
| Name | Type |
|---|---|
annexes |
Array<string> |
assigned |
boolean |
breadcrumbParent |
Displayable |
campaign |
Campaign |
campaignContacts |
Array<CampaignContact> |
clientPartition |
ClientPartition |
constituent |
Constituent |
contactCount |
integer(int32) |
contactGroupRole |
string |
deactivated |
boolean |
description |
string |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
entity |
BaseEntity |
entityGroup |
EntityGroup |
entityRoles |
Array<EntityRole> |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
inUse |
boolean |
legislations |
Array<string> |
member |
boolean |
name |
string |
pages |
Array<CampaignPage> |
partition |
ClientPartition |
partitionId |
integer(int64) |
recordName |
string |
registrationRoles |
Array<string> |
sanctioned |
boolean |
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 |
forNewUi |
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 |
created |
string(date-time) |
createdBy |
User |
createdDate |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
hidden |
boolean |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
User |
lastUpdatedById |
integer(int64) |
name |
string |
partition |
ClientPartition |
published |
boolean |
ragStatus |
string |
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 |
partitionId |
integer(int64) |
ClientPartition¶
| Name | Type |
|---|---|
accessType |
string |
archivedStudyFolder |
Folder |
breadcrumbParent |
Displayable |
campaignImages |
Array<CampaignImage> |
campaignNavigationLevel |
integer(int32) |
campaignTasks |
Array<CampaignContactTask> |
clientPortalUrl |
string |
countries |
Array<Country> |
deactivatedMessage |
string |
defaultBudgetType |
string |
deletedStudyFolder |
Folder |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
docExpiryNotificationDays |
integer(int32) |
email |
string |
emailFolder |
Folder |
entities |
Array<BaseEntity> |
expand |
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 |
partitionStudyCode |
string |
pc |
boolean |
private |
boolean |
public |
boolean |
recordName |
string |
studyAdditionalSharePercent |
integer(int32) |
studyFolder |
Folder |
studyMultiRegistrantShare |
integer(int32) |
studyNumberTimelineTemplate |
StudyTimelineTemplate |
studyTimelineTemplate |
StudyTimelineTemplate |
supportEmail |
string |
url |
string |
userPartitions |
Array<UserPartition> |
Comment¶
| Name | Type |
|---|---|
allDay |
boolean |
breadcrumbParent |
Displayable |
calendarEnd |
string(date-time) |
calendarExtendedProps |
|
calendarSource |
string |
contact |
Contact |
created |
string(date-time) |
createdBy |
User |
createdDate |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
hidden |
boolean |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
User |
lastUpdatedById |
integer(int64) |
name |
string |
partition |
ClientPartition |
published |
boolean |
ragStatus |
string |
recordName |
string |
reply |
boolean |
replyTo |
Comment |
replyToIsUnpublished |
boolean |
serverCreatedReadableDate |
string |
text |
string |
user |
User |
Composite¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
constituent |
Constituent |
created |
string(date-time) |
createdBy |
User |
current |
boolean |
currentVersion |
CompositeVersion |
def |
string |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedById |
integer(int64) |
latestVersion |
CompositeVersion |
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
product |
Product |
recordName |
string |
remarks |
string |
substance |
Substance |
supportsRange |
boolean |
type |
CompositeType |
url |
string |
CompositeProportion¶
| Name | Type |
|---|---|
childConstituent |
Constituent |
childName |
string |
childVersion |
CompositeVersion |
created |
string(date-time) |
createdBy |
User |
id |
integer(int64) |
lastUpdated |
string(date-time) |
lowerOperator |
string |
lowerPercentage |
number |
parentCompositeProportion |
CompositeProportion |
parentVersion |
CompositeVersion |
partitionId |
integer(int64) |
percentage |
number |
type |
string |
upperOperator |
string |
upperPercentage |
number |
CompositeProportionData¶
| Name | Type |
|---|---|
childConstituent |
ConstituentData |
childName |
string |
childVersion |
CompositeVersionData |
display |
string |
id |
integer(int64) |
name |
string |
parentVersion |
CompositeVersionData |
percentage |
number |
CompositeType¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
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) |
proportionTypes |
Array<string> |
recordName |
string |
supportsFreetext |
boolean |
supportsRange |
boolean |
supportsSubVersions |
boolean |
supportsTypes |
string |
url |
string |
CompositeVersion¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
childProportions |
Array<CompositeProportion> |
composite |
Composite |
compositeType |
CompositeType |
constituent |
Constituent |
contextProportions |
Array<CompositeProportion> |
created |
string(date-time) |
createdBy |
User |
current |
boolean |
currentVersion |
CompositeVersion |
descendantConstituents |
Array<Constituent> |
descendantProportions |
Array<CompositeProportion> |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
end |
string(date) |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedById |
integer(int64) |
latest |
boolean |
latestVersion |
CompositeVersion |
name |
string |
number |
integer(int32) |
parentProportions |
Array<CompositeProportion> |
partition |
ClientPartition |
partitionId |
integer(int64) |
product |
Product |
recordName |
string |
remarks |
string |
start |
string(date) |
substance |
Substance |
url |
string |
CompositeVersionData¶
| Name | Type |
|---|---|
composition |
CompositionData |
created |
string(date-time) |
createdBy |
UserData |
current |
boolean |
end |
string(date) |
formulation |
FormulationData |
id |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
UserData |
number |
integer(int32) |
remarks |
string |
start |
string(date) |
Composition¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
constituent |
Constituent |
created |
string(date-time) |
createdBy |
User |
current |
boolean |
currentVersion |
CompositeVersion |
def |
string |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedById |
integer(int64) |
latestVersion |
CompositeVersion |
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
product |
Product |
recordName |
string |
remarks |
string |
substance |
Substance |
supportsRange |
boolean |
type |
CompositionType |
url |
string |
CompositionData¶
| Name | Type |
|---|---|
constituent |
ConstituentData |
created |
string(date-time) |
createdBy |
UserData |
id |
integer(int64) |
identifier |
string |
lastUpdated |
string(date-time) |
lastUpdatedBy |
UserData |
product |
ProductData |
remarks |
string |
type |
CompositionTypeData |
CompositionType¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
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) |
proportionTypes |
Array<string> |
recordName |
string |
supportsFreetext |
boolean |
supportsRange |
boolean |
supportsSubVersions |
boolean |
supportsTypes |
string |
url |
string |
CompositionTypeData¶
| Name | Type |
|---|---|
id |
integer(int64) |
name |
string |
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 |
|---|---|
archived |
boolean |
casNumber |
string |
created |
string(date-time) |
createdBy |
UserData |
ecDescription |
string |
ecName |
string |
ecNumber |
string |
id |
integer(int64) |
inChl |
string |
iuclidUuid |
string |
iupac |
string |
lastUpdated |
string(date-time) |
lastUpdatedBy |
UserData |
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) |
ConstituentEntityData¶
| Name | Type |
|---|---|
constituent |
ConstituentData |
created |
string(date-time) |
createdBy |
UserData |
end |
string(date) |
entity |
EntityData |
id |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
UserData |
roles |
Array<EntityRoleData> |
start |
string(date) |
ConstituentParty¶
| Name | Type |
|---|---|
constituent |
Constituent |
deleted |
boolean |
end |
string(date) |
id |
integer(int64) |
party |
Party |
start |
string(date) |
ConstituentPartyContact¶
| Name | Type |
|---|---|
constituentParty |
ConstituentParty |
contact |
Contact |
deleted |
boolean |
id |
integer(int64) |
ConstituentPartyData¶
| Name | Type |
|---|---|
address |
PartyData |
constituent |
ConstituentData |
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 |
formulation |
Formulation |
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) |
tonnesImported |
number(double) |
tonnesManufactured |
number(double) |
tonnesOwnImport |
number(double) |
tonnesOwnProduction |
number(double) |
total |
number(double) |
user |
User |
ConstituentTypeData¶
| Name | Type |
|---|---|
code |
string |
composite |
boolean |
icon |
string |
id |
integer(int64) |
name |
string |
Contact¶
| Name | Type |
|---|---|
analyticalSamples |
Array<AnalyticalSample> |
campaignContacts |
Array<CampaignContact> |
constituentContacts |
Array<ConstituentContact> |
constituentEntityContacts |
Array<ConstituentEntityContact> |
constituentPartyContacts |
Array<ConstituentPartyContact> |
contactGroups |
Array<ContactContactGroup> |
contactRecipients |
Array<ContactRecipient> |
deactivated |
boolean |
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 |
pages |
Array<CampaignPage> |
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 |
tasks |
Array<CampaignContactTask> |
telephone |
string |
testingLaboratoryContacts |
Array<TestingLaboratoryContact> |
title |
string |
tonnageAndUseEnquiries |
Array<TonnageAndUseEnquiry> |
user |
User |
ContactContactGroup¶
| Name | Type |
|---|---|
contact |
Contact |
contactGroup |
ContactGroup |
deleted |
boolean |
id |
integer(int64) |
role |
string |
ContactData¶
| Name | Type |
|---|---|
archived |
boolean |
created |
string(date-time) |
createdBy |
UserData |
email |
string |
fax |
string |
firstName |
string |
id |
integer(int64) |
jobDescription |
string |
lastLoggedIn |
string(date-time) |
lastName |
string |
lastUpdated |
string(date-time) |
lastUpdatedBy |
UserData |
mobile |
string |
nameSuffix |
string |
partitionId |
integer(int64) |
skype |
string |
telephone |
string |
title |
string |
ContactGroup¶
| Name | Type |
|---|---|
groupName |
string |
partitionId |
integer(int64) |
ContactRecipient¶
| Name | Type |
|---|---|
contact |
Contact |
deleted |
boolean |
documentEmailInternal |
DocumentEmailInternal |
domain |
string |
emailAddress |
string |
entities |
Array<BaseEntity> |
firstName |
string |
fullName |
string |
id |
integer(int64) |
secondName |
string |
type |
string |
CostOverviewable¶
| Name | Type |
|---|---|
additionalShare |
integer(int32) |
additionalShareDecimal |
number |
breadcrumbParent |
Displayable |
budgetType |
string |
categoryGroups |
Array<CategoryGroup> |
constituents |
Array<Constituent> |
constituentsFallback |
Array<Constituent> |
costsShared |
boolean |
currency |
string |
currencyInstance |
Properties: currencyCode, numericCodeAsString, displayName, symbol, defaultFractionDigits, numericCode |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
externalRef |
string |
iconClass |
string |
iconColour |
string |
id |
|
idInPartition |
integer(int64) |
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
products |
Array<Product> |
recordName |
string |
url |
string |
CostOverviewRow¶
| Name | Type |
|---|---|
appliesFrom |
string(date) |
appliesTo |
string(date) |
balance |
number |
balanceForEntity |
number |
balanceIn |
number |
categoryGroups |
Array<CategoryGroup> |
constituent |
Constituent |
constituentOfInterest |
Constituent |
constituentsOfInterest |
Array<Constituent> |
cost |
number |
costActual |
number |
costs |
|
costTotal |
number |
costVsActualString |
string |
currency |
Properties: currencyCode, numericCodeAsString, displayName, symbol, defaultFractionDigits, numericCode |
entities |
Array<BaseEntity> |
entity |
BaseEntity |
entityInterest |
EntityInterest |
entityInterests |
Array<EntityInterest> |
invoicedIn |
number |
invoicedOut |
number |
invoicedOutstanding |
number |
invoicedOutstandingForEntity |
number |
invoicedOutToEntity |
number |
journal |
string |
month |
string |
monthDisplay |
string |
outgoingInvoices |
Array<DocumentInvoice> |
paid |
number |
paidIn |
number |
paidInByEntity |
number |
purchaseOrderNumbers |
Array<string> |
quarter |
integer(int32) |
reasonsForInterest |
Array<string> |
record |
CostOverviewable |
records |
Array<CostOverviewable> |
registrationNumbers |
Array<string> |
registrations |
Array<ReachRegistration> |
roleDisplays |
Array<string> |
summaries |
Array<CostSplitSummary> |
year |
integer(int32) |
CostSplitSummary¶
| Name | Type |
|---|---|
constituentOfInterest |
Constituent |
costActual |
number |
costs |
|
entity |
BaseEntity |
interest |
EntityInterest |
invoicedIn |
number |
invoicedOut |
number |
paidIn |
number |
paidOut |
number |
record |
CostOverviewable |
summary |
CostSummary |
CostSummary¶
| Name | Type |
|---|---|
baseCostActualShare |
number |
baseInvoicedInShare |
number |
baseInvoicedOutShare |
number |
basePaidInShare |
number |
basePaidOutShare |
number |
baseShares |
|
costActualTotal |
number |
costTotal |
number |
costTotalByType |
|
invoicedInTotal |
number |
invoicedOutTotal |
number |
paidInTotal |
number |
paidOutTotal |
number |
record |
CostOverviewable |
reducedCostActualShare |
number |
reducedInvoicedInShare |
number |
reducedInvoicedOutShare |
number |
reducedPaidInShare |
number |
reducedPaidOutShare |
number |
reducedShares |
|
shares |
Country¶
| Name | Type |
|---|---|
id |
integer(int64) |
iso3166alpha2CountryCode |
string |
iso3166alpha3CountryCode |
string |
iso3166numeric3CountryCode |
string |
name |
string |
partitionId |
integer(int64) |
CountryData¶
| Name | Type |
|---|---|
id |
integer(int64) |
iso3166alpha2CountryCode |
string |
iso3166alpha3CountryCode |
string |
name |
string |
CreatedInvoiceData¶
| Name | Type |
|---|---|
document |
DocumentData |
iplicitDocNo |
string |
iplicitId |
string(uuid) |
CreatedInvoicesData¶
| Name | Type |
|---|---|
form |
InvoiceFormData |
invoices |
Array<CreatedInvoiceData> |
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 |
DisplayConfig¶
| Name | Type |
|---|---|
address |
string |
invoicePageFooter |
string |
invoicingContacts |
string |
otherEntity |
BaseEntity |
purchaseNumber |
string |
showing |
string |
vat |
string |
Document¶
| Name | Type |
|---|---|
categoryGroups |
Array<CategoryGroup> |
comments |
Array<DocumentComment> |
constituents |
Array<Constituent> |
constituentTonnages |
Array<ConstituentTonnage> |
contactGroups |
Array<ContactGroup> |
created |
string(date-time) |
createdBy |
User |
currentDocument |
Document |
currentDocumentId |
integer(int64) |
deleted |
boolean |
deletedDate |
string(date-time) |
description |
string |
docType |
string |
documentCreationDate |
string(date) |
documentLinkAttachments |
Array<DocumentLinkAttachment> |
documentTagSet |
Array<DocumentTag> |
documentTask |
CampaignContactTask |
entities |
Array<BaseEntity> |
entityGroups |
Array<EntityGroup> |
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 |
productGroups |
Array<ProductGroup> |
products |
Array<Product> |
productTonnages |
Array<ProductTonnage> |
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 |
versions |
Array<Document> |
watchingUsers |
Array<User> |
DocumentComment¶
| Name | Type |
|---|---|
allDay |
boolean |
breadcrumbParent |
Displayable |
calendarEnd |
string(date-time) |
calendarExtendedProps |
|
calendarSource |
string |
contact |
Contact |
created |
string(date-time) |
createdBy |
User |
createdDate |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
forTocEntry |
boolean |
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 |
partition |
ClientPartition |
published |
boolean |
ragStatus |
string |
recordName |
string |
replies |
Array<Comment> |
reply |
boolean |
replyTo |
Comment |
replyToIsUnpublished |
boolean |
serverCreatedReadableDate |
string |
text |
string |
tocEntry |
IuclidTocEntry |
user |
User |
wrapper |
IUCLIDDocumentWrapper |
wrapperFallback |
IUCLIDDocumentWrapper |
wrapperId |
string |
DocumentCostSplit¶
| Name | Type |
|---|---|
budget |
Budget |
categoryGroup |
CategoryGroup |
constituent |
Constituent |
cost |
number |
costSameAsTotal |
boolean |
document |
Document |
id |
integer(int64) |
product |
Product |
records |
Array<> |
study |
Study |
DocumentData¶
| Name | Type |
|---|---|
accountantReference |
string |
constituents |
Array<ConstituentData> |
contractDate |
string(date) |
contractType |
string |
cost |
number |
created |
string(date-time) |
createdBy |
UserData |
currency |
string |
documentCreationDate |
string(date) |
entities |
Array<EntityData> |
fee |
number |
fromEntity |
EntityData |
id |
integer(int64) |
invoiceDate |
string(date) |
invoiceNumber |
string |
invoiceType |
string |
lastUpdated |
string(date-time) |
lastUpdatedBy |
UserData |
legislation |
string |
name |
string |
outstandingAmount |
number |
partitionId |
integer(int64) |
paymentApproved |
boolean |
paymentApprovedBy |
UserData |
paymentApprovedDate |
string(date) |
paymentReceived |
boolean |
paymentReceivedDate |
string(date) |
paymentSent |
boolean |
paymentSentBy |
UserData |
paymentSentDate |
string(date) |
products |
Array<ProductData> |
purchaseOrder |
string |
sentViaEmail |
boolean |
subTotal |
number |
toEntity |
EntityData |
tonnageBand |
string |
total |
number |
type |
string |
vat |
number |
DocumentDate¶
| Name | Type |
|---|---|
dateAccessed |
string(date-time) |
document |
Document |
events |
Array<CampaignContactEvent> |
id |
integer(int64) |
DocumentEmailExternal¶
| Name | Type |
|---|---|
attachments |
Array<Document> |
attachmentsToSave |
Array<ReceivedEmailAttachment> |
categoryGroups |
Array<CategoryGroup> |
ccAddresses |
string |
comments |
Array<DocumentComment> |
constituents |
Array<Constituent> |
constituentTonnages |
Array<ConstituentTonnage> |
contactGroups |
Array<ContactGroup> |
created |
string(date-time) |
createdBy |
User |
currentDocument |
Document |
currentDocumentId |
integer(int64) |
deleted |
boolean |
deletedDate |
string(date-time) |
description |
string |
docType |
string |
documentCreationDate |
string(date) |
documentLinkAttachments |
Array<DocumentLinkAttachment> |
documentTask |
CampaignContactTask |
emailBody |
string |
emailDate |
string(date) |
entities |
Array<BaseEntity> |
entityGroups |
Array<EntityGroup> |
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 |
missingAttachments |
Array<ReceivedEmailAttachment> |
newsItem |
boolean |
notifyEmail |
string |
originalFileName |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
permanent |
boolean |
productGroups |
Array<ProductGroup> |
products |
Array<Product> |
productTonnages |
Array<ProductTonnage> |
receivedDate |
string(date-time) |
recipient |
string |
retentionDate |
string(date) |
retentionNotifications |
Array<NotificationDocRetention> |
retentionNotified |
boolean |
searchedVia |
Document |
sender |
string |
subject |
string |
submissions |
Array<ReachITRegistration> |
taskLinks |
Array<CampaignContactTask> |
taskTwoLinks |
Array<CampaignContactTask> |
title |
string |
uploadDate |
string(date-time) |
version |
integer(int32) |
versionIdentifier |
string |
watchingUsers |
Array<User> |
DocumentEmailInternal¶
| Name | Type |
|---|---|
attachments |
Array<Document> |
bcc |
string |
categoryGroups |
Array<CategoryGroup> |
cc |
string |
comments |
Array<DocumentComment> |
constituents |
Array<Constituent> |
constituentTonnages |
Array<ConstituentTonnage> |
contactGroups |
Array<ContactGroup> |
created |
string(date-time) |
createdBy |
User |
currentDocument |
Document |
currentDocumentId |
integer(int64) |
deleted |
boolean |
deletedDate |
string(date-time) |
description |
string |
docType |
string |
documentCreationDate |
string(date) |
documentLinkAttachments |
Array<DocumentLinkAttachment> |
documentTask |
CampaignContactTask |
duplicates |
Array<DocumentEmailInternal> |
emailBody |
string |
emailDate |
string(date-time) |
entities |
Array<BaseEntity> |
entityGroups |
Array<EntityGroup> |
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 |
newsItem |
boolean |
notifyEmail |
string |
originalFileName |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
permanent |
boolean |
privatise |
boolean |
productGroups |
Array<ProductGroup> |
products |
Array<Product> |
productTonnages |
Array<ProductTonnage> |
recipients |
Array<ContactRecipient> |
retentionDate |
string(date) |
retentionNotifications |
Array<NotificationDocRetention> |
retentionNotified |
boolean |
saveAsDraft |
boolean |
searchedVia |
Document |
sender |
string |
subject |
string |
submissions |
Array<ReachITRegistration> |
taskLinks |
Array<CampaignContactTask> |
taskTwoLinks |
Array<CampaignContactTask> |
title |
string |
uploadDate |
string(date-time) |
version |
integer(int32) |
versionIdentifier |
string |
watchingUsers |
Array<User> |
DocumentInvoice¶
| Name | Type |
|---|---|
accountantReference |
string |
approved |
boolean |
approvedBy |
User |
approvedDate |
string(date) |
budgets |
Array<Budget> |
categoryGroups |
Array<CategoryGroup> |
comments |
Array<DocumentComment> |
constituents |
Array<Constituent> |
constituentTonnages |
Array<ConstituentTonnage> |
contactGroups |
Array<ContactGroup> |
convertedSubTotal |
number |
costSplits |
Array<DocumentCostSplit> |
created |
string(date-time) |
createdBy |
User |
currentDocument |
Document |
currentDocumentId |
integer(int64) |
dateReceived |
string(date) |
deleted |
boolean |
deletedDate |
string(date-time) |
description |
string |
docType |
string |
documentCreationDate |
string(date) |
documentInvoiceType |
string |
documentLinkAttachments |
Array<DocumentLinkAttachment> |
documentTagSet |
Array<DocumentTag> |
documentTask |
CampaignContactTask |
entities |
Array<BaseEntity> |
entityGroups |
Array<EntityGroup> |
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 |
outstandingAmount |
number |
overdueNotifications |
Array<NotificationDocOverdue> |
overdueNotified |
boolean |
paid |
boolean |
paidNotifications |
Array<NotificationPaid> |
partition |
ClientPartition |
partitionId |
integer(int64) |
permanent |
boolean |
productGroups |
Array<ProductGroup> |
products |
Array<Product> |
productTonnages |
Array<ProductTonnage> |
purchaseOrder |
string |
relatedStudies |
Array<Study> |
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 |
|---|---|
account |
string |
amount |
number |
department |
string |
description |
string |
salesCode |
string |
taxed |
boolean |
DocumentIUCLIDOutput¶
| Name | Type |
|---|---|
categoryGroups |
Array<CategoryGroup> |
comments |
Array<DocumentComment> |
constituents |
Array<Constituent> |
contactGroups |
Array<ContactGroup> |
context |
IUCLID6WorkingContext |
created |
string(date-time) |
createdBy |
User |
creationDate |
string(date) |
currentDocument |
Document |
currentDocumentId |
integer(int64) |
deleted |
boolean |
deletedDate |
string(date-time) |
description |
string |
docType |
string |
documentCreationDate |
string(date) |
documentTask |
CampaignContactTask |
entities |
Array<BaseEntity> |
entityGroups |
Array<EntityGroup> |
expirationNotified |
boolean |
expiryDate |
string(date) |
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 |
manifest |
IUCLID6Manifest |
newsItem |
boolean |
notifyEmail |
string |
originalFileName |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
permanent |
boolean |
productGroups |
Array<ProductGroup> |
products |
Array<Product> |
retentionDate |
string(date) |
retentionNotifications |
Array<NotificationDocRetention> |
retentionNotified |
boolean |
searchedVia |
Document |
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) |
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 |
|---|---|
dateDownloaded |
string(date) |
document |
Document |
documentLinks |
Array<DocumentLink> |
id |
integer(int64) |
DocumentTag¶
| Name | Type |
|---|---|
deleted |
boolean |
document |
Document |
id |
integer(int64) |
tag |
Tag |
EmailSendData¶
| Name | Type |
|---|---|
campaign |
Campaign |
cc |
Array<string> |
constituents |
Array<ConstituentData> |
dedupeKey |
string |
documents |
Array<DocumentData> |
entity |
EntityData |
recipients |
Array<ContactData> |
resend |
boolean |
taskGroupIds |
Array<integer(int64)> |
template |
EmailTemplateData |
variables |
Example: {'jsgName': 'Benzene JSG'} |
EmailSentData¶
| Name | Type |
|---|---|
emails |
Array<DocumentData> |
id |
integer(int64) |
skippedEmails |
Array<string> |
transport |
string |
EmailTemplateData¶
| Name | Type |
|---|---|
description |
string |
emailType |
string |
id |
string |
kind |
string |
mergeVariables |
Array<string> |
name |
string |
partitionId |
integer(int64) |
transport |
string |
EntityBudget¶
| Name | Type |
|---|---|
annex |
string |
budget |
Budget |
constituent |
Constituent |
costShare |
boolean |
entity |
BaseEntity |
id |
integer(int64) |
interest |
CostOverviewable |
journal |
string |
percentage |
number |
percentageDecimal |
number |
purchaseOrderNumber |
string |
registration |
ReachRegistration |
role |
string |
shareType |
string |
EntityData¶
| Name | Type |
|---|---|
archived |
boolean |
companyNo |
string |
created |
string(date-time) |
createdBy |
UserData |
dunnNo |
string |
id |
integer(int64) |
invoiceRef |
string |
lastUpdated |
string(date-time) |
lastUpdatedBy |
UserData |
name |
string |
partitionId |
integer(int64) |
reachUuid |
string |
utr |
string |
vatNo |
string |
EntityGroup¶
| Name | Type |
|---|---|
name |
string |
partitionId |
integer(int64) |
EntityInterest¶
| Name | Type |
|---|---|
annex |
string |
constituent |
Constituent |
costShare |
boolean |
entity |
BaseEntity |
id |
integer(int64) |
interest |
CostOverviewable |
journal |
string |
percentage |
number |
percentageDecimal |
number |
purchaseOrderNumber |
string |
registration |
ReachRegistration |
role |
string |
shareType |
string |
EntityRole¶
| Name | Type |
|---|---|
appliesTo |
string |
breadcrumbParent |
Displayable |
categories |
Array<string> |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
groupMembership |
string |
iconClass |
string |
iconColour |
string |
id |
string |
idInPartition |
integer(int64) |
linkRole |
boolean |
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
protected |
boolean |
recordName |
string |
url |
string |
EntityRoleData¶
| Name | Type |
|---|---|
display |
string |
id |
string |
EntityStudy¶
| Name | Type |
|---|---|
annex |
string |
breadcrumbParent |
Displayable |
constituent |
Constituent |
costShare |
boolean |
created |
string(date-time) |
createdBy |
User |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
entity |
BaseEntity |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
interest |
CostOverviewable |
journal |
string |
lastUpdated |
string(date-time) |
lastUpdatedBy |
User |
lastUpdatedById |
integer(int64) |
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
percentage |
number |
percentageDecimal |
number |
purchaseOrderNumber |
string |
recordName |
string |
registration |
ReachRegistration |
role |
string |
sharedWithOthers |
boolean |
shareType |
string |
study |
Study |
url |
string |
EntityStudyGroup¶
| Name | Type |
|---|---|
annex |
string |
constituent |
Constituent |
costShare |
boolean |
entity |
BaseEntity |
group |
StudyGroup |
id |
integer(int64) |
interest |
CostOverviewable |
journal |
string |
percentage |
number |
percentageDecimal |
number |
purchaseOrderNumber |
string |
registration |
ReachRegistration |
role |
string |
shareType |
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 |
|---|---|
createdBy |
UserData |
createdDate |
string(date-time) |
id |
integer(int64) |
name |
string |
parent |
FolderData |
partitionId |
integer(int64) |
Formulation¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
constituent |
Constituent |
constituentTonnages |
Array<ConstituentTonnage> |
created |
string(date-time) |
createdBy |
User |
current |
boolean |
currentVersion |
CompositeVersion |
def |
string |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedById |
integer(int64) |
latestVersion |
CompositeVersion |
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
product |
Product |
productTonnages |
Array<ProductTonnage> |
recordName |
string |
remarks |
string |
substance |
Substance |
supportsRange |
boolean |
type |
FormulationType |
url |
string |
versions |
Array<CompositeVersion> |
FormulationData¶
| Name | Type |
|---|---|
constituent |
ConstituentData |
created |
string(date-time) |
createdBy |
UserData |
id |
integer(int64) |
identifier |
string |
lastUpdated |
string(date-time) |
lastUpdatedBy |
UserData |
product |
ProductData |
remarks |
string |
type |
FormulationTypeData |
FormulationType¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
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) |
proportionTypes |
Array<string> |
recordName |
string |
supportsFreetext |
boolean |
supportsRange |
boolean |
supportsSubVersions |
boolean |
supportsTypes |
string |
url |
string |
FormulationTypeData¶
| Name | Type |
|---|---|
id |
integer(int64) |
name |
string |
I6CategoryDocumentDefinitionIdentifier¶
| Name | Type |
|---|---|
documentSubType |
string |
documentType |
string |
Integration¶
| Name | Type |
|---|---|
authType |
string |
created |
string(date-time) |
credentialEncrypted |
string |
credentialPresent |
boolean |
display |
string |
entity |
BaseEntity |
host |
string |
id |
integer(int64) |
iuclidDocuments |
Array<DocumentIUCLIDOutput> |
lastUpdated |
string(date-time) |
name |
string |
partitionId |
integer(int64) |
principal |
string |
refreshTokenEncrypted |
string |
refreshTokenExpired |
boolean |
tokenEncrypted |
string |
tokenExpired |
boolean |
tokenExpires |
string(date-time) |
tokenExpiring |
boolean |
tokenTransient |
string |
type |
string |
InvoiceeData¶
| Name | Type |
|---|---|
amounts |
Array<number> |
entity |
EntityData |
InvoiceFormData¶
| Name | Type |
|---|---|
async |
boolean |
basedOnDocument |
DocumentData |
currency |
string |
fromEntity |
EntityData |
integrationId |
integer(int64) |
integrationType |
string |
invoices |
Array<InvoiceeData> |
items |
Array<ItemData> |
partitionId |
integer(int64) |
type |
string |
IplicitInvoiceSyncRequest¶
| Name | Type |
|---|---|
clientId |
string| null |
invoiceNumbers |
Array<string| null> |
IplicitInvoiceSyncResponse¶
| Name | Type |
|---|---|
invoices |
Array<IplicitInvoiceSyncResult> |
syncedCount |
integer(int32) |
IplicitInvoiceSyncResult¶
| Name | Type |
|---|---|
documentId |
integer(int64)| null |
invoiceNumber |
string |
message |
string| null |
outcome |
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) |
watchers |
Array<User> |
watching |
boolean |
watchingUsers |
Array<User> |
IssueAndStatementComment¶
| Name | Type |
|---|---|
allDay |
boolean |
breadcrumbParent |
Displayable |
calendarEnd |
string(date-time) |
calendarExtendedProps |
|
calendarSource |
string |
contact |
Contact |
created |
string(date-time) |
createdBy |
User |
createdDate |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
hidden |
boolean |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
User |
lastUpdatedById |
integer(int64) |
name |
string |
partition |
ClientPartition |
published |
boolean |
ragStatus |
string |
recordName |
string |
replies |
Array<Comment> |
reply |
boolean |
replyTo |
Comment |
replyToIsUnpublished |
boolean |
serverCreatedReadableDate |
string |
text |
string |
user |
User |
ItemData¶
| Name | Type |
|---|---|
account |
string |
accountId |
string(uuid) |
amount |
number |
constituents |
Array<ConstituentData> |
department |
string |
departmentId |
string(uuid) |
description |
string |
products |
Array<ProductData> |
salesCode |
string |
taxed |
boolean |
IUCLID6Manifest¶
| Name | Type |
|---|---|
application |
string |
archiveType |
string |
author |
string |
baseDocument |
IUCLIDDocumentWrapper |
baseDocumentUuid |
string |
comment |
string |
context |
IUCLID6WorkingContext |
created |
string(date-time) |
legislation |
|
relevantDocumentType |
string |
relevantUuid |
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 |
latestRagStatus |
string |
latestRagStatusDescendant |
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 |
draftDossier |
boolean |
editFlaggable |
boolean |
endpointSummary |
boolean |
href |
string |
i5Origin |
boolean |
i6CategoryDocumentDefinitionIdentifiers |
Array<I6CategoryDocumentDefinitionIdentifier> |
idString |
string |
iuclidVersion |
string |
key |
string |
lastModificationDate |
string(date-time) |
lastModificationDateFromString |
string |
latestRagStatus |
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> |
treeFlattened |
Array<IUCLID6TocNode> |
type |
string |
uuid |
string |
xml |
string |
IuclidTocEntry¶
| Name | Type |
|---|---|
changeType |
string |
commentCount |
integer(int64) |
descendantComments |
boolean |
display |
string |
idString |
string |
latestRagStatus |
string |
LoginDetailsData¶
| Name | Type |
|---|---|
email |
string |
userId |
integer(int64) |
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) |
createdInstant |
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 |
url |
string |
user |
User |
NotificationCampaignSurvey¶
| Name | Type |
|---|---|
baseUrl |
string |
breadcrumbParent |
Displayable |
campaignContactTask |
CampaignContactTask |
contact |
Contact |
created |
string(date-time) |
createdInstant |
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 |
taskUrl |
string |
url |
string |
user |
User |
NotificationCampaignUpload¶
| Name | Type |
|---|---|
baseUrl |
string |
breadcrumbParent |
Displayable |
campaignContactTask |
CampaignContactTask |
contact |
Contact |
created |
string(date-time) |
createdInstant |
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 |
url |
string |
user |
User |
NotificationDocExpiry¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
created |
string(date-time) |
createdInstant |
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 |
url |
string |
user |
User |
NotificationDocOverdue¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
created |
string(date-time) |
createdInstant |
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 |
url |
string |
user |
User |
NotificationDocRetention¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
created |
string(date-time) |
createdInstant |
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) |
url |
string |
user |
User |
NotificationIuclidReview¶
| Name | Type |
|---|---|
approval |
boolean |
baseUrl |
string |
breadcrumbParent |
Displayable |
campaignContactTask |
CampaignContactTask |
contact |
Contact |
created |
string(date-time) |
createdInstant |
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 |
url |
string |
user |
User |
NotificationPageChange¶
| Name | Type |
|---|---|
baseUrl |
string |
breadcrumbParent |
Displayable |
created |
string(date-time) |
createdInstant |
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 |
type |
string |
url |
string |
user |
User |
NotificationPaid¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
created |
string(date-time) |
createdInstant |
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 |
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) |
PageConstituentEntityData¶
| Name | Type |
|---|---|
content |
Array<ConstituentEntityData> |
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) |
PageConstituentPartyData¶
| Name | Type |
|---|---|
content |
Array<ConstituentPartyData> |
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) |
PagePartyData¶
| Name | Type |
|---|---|
content |
Array<PartyData> |
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) |
PageProductEntityData¶
| Name | Type |
|---|---|
content |
Array<ProductEntityData> |
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) |
PageSearchResultData¶
| Name | Type |
|---|---|
content |
Array<SearchResultData> |
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) |
PageStudyActivityData¶
| Name | Type |
|---|---|
content |
Array<StudyActivityData> |
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) |
PageStudyGroupData¶
| Name | Type |
|---|---|
content |
Array<StudyGroupData> |
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) |
PageStudyManagerData¶
| Name | Type |
|---|---|
content |
Array<StudyManagerData> |
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) |
PageStudyMonitorData¶
| Name | Type |
|---|---|
content |
Array<StudyMonitorData> |
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) |
PageStudyTypeData¶
| Name | Type |
|---|---|
content |
Array<StudyTypeData> |
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 |
|---|---|
accessType |
string |
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 |
created |
string(date-time) |
createdBy |
User |
deleted |
boolean |
description |
string |
entity |
BaseEntity |
fax |
string |
id |
integer(int64) |
lastUpdated |
string(date-time) |
partitionId |
integer(int64) |
plants |
Array<Plant> |
postcode |
string |
remarks |
string |
sapBusinessReference |
string |
telephone |
string |
townCity |
string |
website |
string |
PartyData¶
| Name | Type |
|---|---|
addressLine1 |
string |
addressLine2 |
string |
addressLine3 |
string |
country |
CountryData |
countyStateRegion |
string |
created |
string(date-time) |
createdBy |
UserData |
entity |
EntityData |
id |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
UserData |
name |
string |
postcode |
string |
townCity |
string |
type |
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 |
|---|---|
archived |
boolean |
created |
string(date-time) |
createdBy |
UserData |
id |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
UserData |
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 |
ProductEntityData¶
| Name | Type |
|---|---|
created |
string(date-time) |
createdBy |
UserData |
end |
string(date) |
entity |
EntityData |
id |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
UserData |
product |
ProductData |
roles |
Array<EntityRoleData> |
start |
string(date) |
ProductGroup¶
| Name | Type |
|---|---|
groupName |
string |
partitionId |
integer(int64) |
ProductParty¶
| Name | Type |
|---|---|
deleted |
boolean |
end |
string(date) |
id |
integer(int64) |
party |
Party |
product |
Product |
start |
string(date) |
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 |
formulation |
Formulation |
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) |
total |
number(double) |
user |
User |
ReachITRegistration¶
| Name | Type |
|---|---|
communicationReference |
string |
constituent |
Constituent |
created |
string(date-time) |
dateAccepted |
string(date) |
dateIssued |
string(date) |
dateSubmitted |
string(date) |
forEntity |
BaseEntity |
id |
integer(int64) |
iuclidDossierReference |
string |
lastUpdated |
string(date-time) |
leadRegistrant |
BaseEntity |
legalEntity |
BaseEntity |
notes |
string |
partitionId |
integer(int64) |
reachDossierType |
string |
reachRegistration |
ReachRegistration |
reason |
string |
status |
string |
submissionNumber |
string |
supportingDocument |
Document |
tonnageBand |
string |
ReachRegistration¶
| Name | Type |
|---|---|
annex |
string |
constituent |
Constituent |
constituentTonnages |
Array<ConstituentTonnage> |
created |
string(date-time) |
displayForInterest |
string |
enquiryNumber |
string |
entityBudgets |
Array<EntityBudget> |
entityStudies |
Array<EntityStudy> |
entityStudyGroups |
Array<EntityStudyGroup> |
exempt |
boolean |
exemption |
string |
exemptionClaimed |
string |
exemptionComment |
string |
exemptionDocuments |
Array<Document> |
exemptionType |
string |
forEntity |
BaseEntity |
forEntityUuid |
string |
id |
integer(int64) |
iuclidUUID |
string |
lastUpdated |
string(date-time) |
legalEntity |
BaseEntity |
notePreregistered |
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 |
registeredTonnageBands |
Array<RegisteredTonnageBandWithDate> |
registrationDate |
string(date) |
registrationName |
string |
registrationNotes |
string |
registrationNumber |
string |
registrationRole |
string |
registrationStatus |
string |
source |
string |
submissionDate |
string(date) |
submissionNumber |
string |
submissionType |
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 |
|---|---|
docType |
string |
fileId |
string(uuid) |
filename |
string |
id |
integer(int64) |
likelySignatureImage |
boolean |
receivedEmail |
ReceivedEmail |
savedDocument |
Document |
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 |
|---|---|
annex |
string |
constituent |
ConstituentData |
created |
string(date-time) |
createdBy |
UserData |
effectiveAnnex |
string |
enquiryNumber |
string |
exempt |
boolean |
exemption |
string |
exemptionComment |
string |
exemptionType |
string |
forLegalEntity |
EntityData |
forLegalEntityUuid |
string |
id |
integer(int64) |
iuclidUUID |
string |
lastUpdated |
string(date-time) |
lastUpdatedBy |
UserData |
ppordNumber |
string |
preregistered |
boolean |
preregistrationDate |
string(date) |
preregistrationName |
string |
preregistrationNote |
string |
preregistrationNumber |
string |
publicName |
string |
reachDossierType |
string |
reachLegislation |
string |
reachRole |
string |
registrationDate |
string(date) |
registrationName |
string |
registrationNotes |
string |
registrationNumber |
string |
registrationRole |
string |
status |
string |
submittingLegalEntity |
EntityData |
type |
string |
Role¶
| Name | Type |
|---|---|
admin |
boolean |
defaultNoAccess |
boolean |
deletable |
boolean |
externalGroups |
Array<string> |
forCampaign |
boolean |
forInternal |
boolean |
id |
integer(int64) |
name |
string |
penmanAdmin |
boolean |
permissions |
Array<string> |
SearchResultData¶
| Name | Type |
|---|---|
entityType |
string |
id |
integer(int64) |
name |
string |
partitionId |
integer(int64) |
score |
number(float) |
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) |
created |
string(date-time) |
createdBy |
User |
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> |
lastUpdated |
string(date-time) |
lastUpdatedBy |
User |
lastUpdatedById |
integer(int64) |
multipleInheritanceDates |
boolean |
name |
string |
overdue |
boolean |
overdueNotifications |
Array<NotificationActivityOverdue> |
overdueNotified |
boolean |
partition |
ClientPartition |
partitionId |
integer(int64) |
planned |
string(date) |
recordName |
string |
signedBy |
User |
status |
string |
studyNumber |
StudyNumber |
template |
StudyActivityTemplate |
url |
string |
watching |
boolean |
watchingUsers |
Array<User> |
StudyActivityComment¶
| Name | Type |
|---|---|
allDay |
boolean |
breadcrumbParent |
Displayable |
calendarEnd |
string(date-time) |
calendarExtendedProps |
|
calendarSource |
string |
contact |
Contact |
created |
string(date-time) |
createdBy |
User |
createdDate |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
hidden |
boolean |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
User |
lastUpdatedById |
integer(int64) |
name |
string |
partition |
ClientPartition |
published |
boolean |
ragStatus |
string |
recordName |
string |
replies |
Array<Comment> |
reply |
boolean |
replyTo |
Comment |
replyToIsUnpublished |
boolean |
serverCreatedReadableDate |
string |
text |
string |
user |
User |
StudyActivityData¶
| Name | Type |
|---|---|
activity |
StudyNumberData |
completedDate |
string(date) |
id |
integer(int64) |
name |
string |
plannedDate |
string(date) |
signedBy |
UserData |
status |
string |
study |
StudyData |
StudyActivityTemplate¶
| Name | Type |
|---|---|
activities |
Array<StudyActivity> |
autoPlannedAfter |
integer(int64) |
autoPlannedAfterPrevious |
integer(int64) |
id |
integer(int64) |
name |
string |
responsible |
string |
sortOrder |
integer(int32) |
timelineTemplate |
StudyTimelineTemplate |
StudyData¶
| Name | Type |
|---|---|
archived |
boolean |
created |
string(date-time) |
createdBy |
UserData |
end |
string(date) |
id |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
UserData |
name |
string |
partitionId |
integer(int64) |
purpose |
string |
start |
string(date) |
status |
string |
testingLaboratoryEntity |
EntityData |
StudyGroup¶
| Name | Type |
|---|---|
activities |
Array<StudyGroupActivity> |
additionalShare |
integer(int32) |
additionalShareDecimal |
number |
breadcrumbParent |
Displayable |
budgetType |
string |
clientPartition |
ClientPartition |
commentDisplayUrl |
string |
comments |
Array<StudyGroupComment> |
commentsEditPermission |
string |
commentsPermission |
string |
commentType |
string |
constituentsFallback |
Array<Constituent> |
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 |
entityStudyGroups |
Array<EntityStudyGroup> |
externalRef |
string |
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) |
products |
Array<Product> |
recordName |
string |
studies |
Array<Study> |
studiesCount |
integer(int64) |
url |
string |
watchers |
Array<User> |
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 |
created |
string(date-time) |
createdBy |
User |
createdDate |
string(date-time) |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
hidden |
boolean |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
User |
lastUpdatedById |
integer(int64) |
name |
string |
partition |
ClientPartition |
published |
boolean |
ragStatus |
string |
recordName |
string |
replies |
Array<Comment> |
reply |
boolean |
replyTo |
Comment |
replyToIsUnpublished |
boolean |
serverCreatedReadableDate |
string |
text |
string |
user |
User |
StudyGroupData¶
| Name | Type |
|---|---|
created |
string(date-time) |
createdBy |
UserData |
description |
string |
id |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
UserData |
name |
string |
partitionId |
integer(int64) |
StudyManagerData¶
| Name | Type |
|---|---|
from |
string(date) |
id |
integer(int64) |
study |
StudyData |
user |
UserData |
StudyMonitorData¶
| Name | Type |
|---|---|
from |
string(date) |
id |
integer(int64) |
study |
StudyData |
user |
UserData |
StudyNumber¶
| Name | Type |
|---|---|
activities |
Array<StudyActivity> |
activity |
string |
activityStudyNumber |
string |
breadcrumbParent |
Displayable |
contractRef |
string |
cost |
number |
created |
string(date-time) |
createdBy |
User |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
emptyCosts |
boolean |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
User |
lastUpdatedById |
integer(int64) |
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
payments |
Array<StudyPaymentActual> |
publishedCost |
number |
publishedPayments |
Array<StudyPaymentPublished> |
recordName |
string |
study |
Study |
studyNumber |
string |
testingLaboratory |
TestingLaboratory |
url |
string |
StudyNumberData¶
| Name | Type |
|---|---|
activity |
string |
contractRef |
string |
id |
integer(int64) |
studyNumber |
string |
StudyPaymentActual¶
| Name | Type |
|---|---|
cost |
number |
estimatedDate |
string(date) |
id |
integer(int64) |
name |
string |
percentage |
number |
quarter |
integer(int32) |
record |
CostOverviewable |
studyNumber |
StudyNumber |
type |
string |
year |
integer(int32) |
yearMonth |
string |
yearQuarter |
PairIntegerInteger |
StudyPaymentPublished¶
| Name | Type |
|---|---|
cost |
number |
estimatedDate |
string(date) |
id |
integer(int64) |
name |
string |
percentage |
number |
quarter |
integer(int32) |
record |
CostOverviewable |
studyNumber |
StudyNumber |
type |
string |
year |
integer(int32) |
yearMonth |
string |
yearQuarter |
PairIntegerInteger |
StudyTimelineTemplate¶
| Name | Type |
|---|---|
activityTemplates |
Array<StudyActivityTemplate> |
id |
integer(int64) |
name |
string |
StudyTypeData¶
| Name | Type |
|---|---|
description |
string |
id |
integer(int64) |
SubmissionData¶
| Name | Type |
|---|---|
communicationReference |
string |
created |
string(date-time) |
createdBy |
UserData |
dateAccepted |
string(date) |
dateIssued |
string(date) |
dateSubmitted |
string(date) |
id |
integer(int64) |
iuclidDossierReference |
string |
lastUpdated |
string(date-time) |
lastUpdatedBy |
UserData |
notes |
string |
reachDossierType |
string |
reason |
string |
registeredTonnageBand |
string |
registration |
RegistrationData |
status |
string |
submissionNumber |
string |
tonnageBand |
string |
Substance¶
| Name | Type |
|---|---|
breadcrumbParent |
Displayable |
compositeDef |
string |
composites |
Array<Composite> |
compositions |
Array<Composition> |
currentFormulations |
Array<Formulation> |
defaultTonnageFormulation |
Formulation |
deleted |
boolean |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
formulations |
Array<Formulation> |
iconClass |
string |
iconColour |
string |
id |
|
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
latestFormulation |
Formulation |
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
recordName |
string |
supportsCompositions |
boolean |
supportsFormulations |
boolean |
url |
string |
SurveyField¶
| Name | Type |
|---|---|
campaignContactTask |
CampaignContactTask |
color |
string |
defaultValue |
string |
fieldType |
string |
id |
integer(int64) |
index |
integer(int32) |
name |
string |
nameAsText |
string |
nameContainsHtml |
boolean |
nameIssues |
Array<SecurityIssue> |
namePreview |
string |
range |
boolean |
rangeMaximum |
number |
rangeMinimum |
number |
required |
boolean |
selectOptionValues |
Array<SurveyFieldSelectValue> |
selectValuesArray |
Array<string> |
SurveyFieldSelectValue¶
| Name | Type |
|---|---|
id |
integer(int64) |
index |
integer(int32) |
surveyField |
SurveyField |
value |
string |
SurveyFieldTemplate¶
| Name | Type |
|---|---|
color |
string |
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 |
|---|---|
breadcrumbParent |
Displayable |
contact |
Contact |
created |
string(date-time) |
createdBy |
User |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
iconClass |
string |
iconColour |
string |
id |
integer(int64) |
idInPartition |
integer(int64) |
lastUpdated |
string(date-time) |
lastUpdatedBy |
User |
lastUpdatedById |
integer(int64) |
name |
string |
partition |
ClientPartition |
partitionId |
integer(int64) |
recordName |
string |
role |
string |
testingLaboratory |
TestingLaboratory |
url |
string |
TestingLaboratoryEvaluation¶
| Name | Type |
|---|---|
id |
integer(int64) |
metric |
TestingLaboratoryEvaluationMetric |
score |
string |
TestingLaboratoryEvaluationMetric¶
| 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) |
createdBy |
User |
credentialsType |
string |
defaultTimeZone |
string |
deleted |
boolean |
display |
string |
displayArgs |
Array<string> |
displayAttributes |
Array<> |
displayCodePartial |
string |
eligible |
boolean |
emailAddress |
string |
enabled |
boolean |
entityGroups |
Array<EntityGroup> |
externalId |
string |
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 |
lockedTime |
string(date-time) |
name |
string |
nameReversed |
string |
notActiveAfter |
string(date) |
owner |
BaseEntity |
partition |
ClientPartition |
partitionId |
integer(int64) |
passwordExpires |
string(date) |
principal |
string |
recordName |
string |
role |
Role |
scimManaged |
boolean |
securityVersion |
integer(int32) |
showNewUi |
boolean |
temporaryPasswordActive |
boolean |
termsAccepted |
boolean |
uiBannerDismissed |
boolean |
url |
string |
version |
integer(int32) |
UserData¶
| Name | Type |
|---|---|
emailAddress |
string |
firstName |
string |
id |
integer(int64) |
lastName |
string |
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 |
|---|---|
additionalUsesFile |
string(uuid) |
additionalUsesFileName |
string |
additionalUsesNotes |
string |
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) |
polymerImportedTonnage |
number |
recordName |
string |
referralCode |
string |
referrer |
BaseEntity |
residualMonomerConcentration |
number |
role |
string |
status |
string |
url |
string |
useTonnages |
Array<UseSurveyTonnage> |
validTonnageFromLastYear |
boolean |
UseSurveyTonnage¶
| Name | Type |
|---|---|
environmentalQuestionsFile |
string(uuid) |
environmentalQuestionsFileName |
string |
exposureMonitored |
boolean |
functions |
Array<UseSurveyTonnageFunction> |
id |
integer(int64) |
intentionallyBlendedIntoFuel |
boolean |
itselfUsedAsFuel |
boolean |
legalEmissions |
boolean |
maxSiteTonnage |
number |
monitoringDataForTreatmentDetails |
string |
monitoringDataForTreatmentProvided |
boolean |
notes |
string |
proceduresDocumented |
boolean |
proportionOfSubstanceEmittedDetails |
string |
proportionOfSubstanceEmittedProvided |
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 |
Tags¶
| Name | Description |
|---|---|
| IPLICIT Integration | Endpoints for synchronizing invoices from the IPLICIT accounting system |
| Composition Item Types | The composition item types configured on this instance, curated by its administrators. 'code' is the stable value used as a composition item's 'type'; 'name' is a display label and may change. |