Skip to content

Insert Project

Request

Security
OAuth2(Required scopes: enrichment.write)
Bodyapplication/jsonrequired
externalIdstring^\S([\S ]*\S)?$required

External id of the project that is globally unique across the provided project data

Example:"SAP:PRPS:0000123456"
externalClientIdstring

Identifier of the client entity in the source system which can be used to separate data

Example:"100"
codestringrequired

Code of the project in the source system (not unique across clients)

Example:"PROJ1234"
projectReferenceNumberstring

Use for converted WBS Element number

Example:"PRJ-2025-BER-GRID"
createdDatestring, (date)

Date when the project was created

Example:"2025-01-15"
fiscalYearLabelstring

Label used in the source system for the fiscal year

Example:"2025"
languagestring or null(LanguageCode)

Two letter language code as defined in ISO 639-1

Enum:"aa""ab""ae""af""ak""am""an""ar""as""av"
Example:"en"
externalCompanyIdstring

External unique id of the company in the source system

Example:"DE01"
statusstring

Current status of the project

Example:"OPEN"
startDatestring, (date)

Project start date

Example:"2025-01-01"
endDatestring, (date)

Project end date

Example:"2025-01-01"
typestring

Type of the project

Example:"consulting"
descriptionstring

Detailed description of the project

Example:"Reinforcement of Berlin transmission grid, including substation upgrades and cable replacements."
shortDescriptionstring

Short description of the project

Example:"Berlin Grid Upgrade"
profitCenterCodestring

Code of the profit center associated with the project

Example:"PC1001"
responsibleCostCenterCodestring

Code of the responsible cost center

Example:"CC2005"
costCenterCodeForPostingstring

Code of the cost center for posting transactions

Example:"CC3002"
currencystring or null(CurrencyCode)

Three letter currency code as defined in ISO 4217

Enum:"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
Example:"EUR"
subProjectCodestring

Code of the sub-project if applicable

Example:"BER-GRID-01"
parentProjectCodestring

Code of the parent project if applicable

Example:"PRJ-2025-INFRA"
customFieldsobject(customFields)

List of key value pairs containing custom fields from the source system

customMetadataobject(JsonObject)

Any nested structure with metadata that source system needs to send

Example:
{
  "someTopLevelProperty": "value1",
  "someNestedProperty": {
    "nestedProperty": "value2"
  },
  "someArrayProperty": [
    "value3",
    "value4"
  ]
}
curl -i -X POST \
  https://api.cloud.hypatos.ai/v2/enrichment/projects \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "externalId": "SAP:PRPS:0000123456",
    "externalClientId": "100",
    "code": "PROJ1234",
    "projectReferenceNumber": "PRJ-2025-BER-GRID",
    "createdDate": "2025-01-15",
    "fiscalYearLabel": "2025",
    "language": "en",
    "externalCompanyId": "DE01",
    "status": "OPEN",
    "startDate": "2025-01-01",
    "endDate": "2025-01-01",
    "type": "consulting",
    "description": "Reinforcement of Berlin transmission grid, including substation upgrades and cable replacements.",
    "shortDescription": "Berlin Grid Upgrade",
    "profitCenterCode": "PC1001",
    "responsibleCostCenterCode": "CC2005",
    "costCenterCodeForPosting": "CC3002",
    "currency": "EUR",
    "subProjectCode": "BER-GRID-01",
    "parentProjectCode": "PRJ-2025-INFRA",
    "customFields": {
      "property1": "string",
      "property2": "string"
    },
    "customMetadata": {
      "someTopLevelProperty": "value1",
      "someNestedProperty": {
        "nestedProperty": "value2"
      },
      "someArrayProperty": [
        "value3",
        "value4"
      ]
    }
  }'

Responses

Successfully inserted

Bodyapplication/json
idstringrequired
Example:"3a429dc8-56d4-42ef-a4cf-2ebc9ad1ef38"
Response
{
  "id": "3a429dc8-56d4-42ef-a4cf-2ebc9ad1ef38"
}