Skip to main content

Web Service Method: Create a Project Using JSON

14/10/2026

Creates a new project using JSON.

Request

Method	POST
URL	`/PoolParty/api/projects/create`
Content-Type	application/json

Attribute	Type	Required	Comment
`defaultLanguage`	String	true	Default language of the project. You must use a language ID. For example, `en` for English.
`title`	String	true	Project title
`userGroups`	Array of String	true	User groups
`author`	String	false	Project author
`availableLanguages`	Array of String	false	Additional languages
`baseURL`	String	false	Base URL of the project
`contributor`	String	false	Project contributor
`description`	String	false	Project description
`enableSkosXl`	boolean	false	Enable SKOS-XL
`enableWorkflow`	boolean	false	Enable workflow
`idGeneration`	String	false	ID-generation method. Possible values: `increment` `prefLabel` `uuid` `manual`
`incrementStart`	int	false	You only need to set the increment start when the ID-generation method is set to `increment`. It specifies the starting number for ID generation for concepts.
`license`	String	false	Project license. Must be a valid URI.
`projectIdentifier`	String	false	Project identifier
Note Project identifier cannot contain spaces. For example: New Project. Otherwise, you receive a response containing: `"status": 400, "message": "http://example.x/New Project is not a valid uri. Change either base url or project identifier"`
`publisher`	String	false	Project publisher
`qualitySetting`	String	false	Quality setting. Possible values: `default` `autoIndexing` `classification` `documentsuggestion` `restricted` `disabled`
`snapshotInterval`	int	false	Snapshot interval. Possible values: `5` `10` `15` `30` `-1` (to disable it)
`subject`	String	false	Primary subject of the project
`uuid`	String	false	Project UUID. If a UUID is provided, universal uniqueness must be guaranteed by the user.
`workflowAssignee`	String	false	URI of the user that will be assigned to the workflow. Only use this attribute when the workflow is enabled.
`workflowState`	String	false	State of the workflow. Possible values: `DRAFT` `APPROVED`

{{base_url}}/PoolParty/api/projects/create

{
  "defaultLanguage": "cs-CZ",
  "title": "New Test Project",
  "userGroups": [
    "Public",
    "Graphwise"
  ]
}

Response - Success

Status	201 Created
Content-Type	application/json

{
  "id": "1a7b68dd-a3b3-41f5-8dca-93fdafd4d8e8",
  "uri": "http://localhost:8081/New-Test-Project",
  "title": "New Test Project",
  "subject": null,
  "availableLanguages": [
    "cs-CZ"
  ],
  "defaultLanguage": "cs-cz",
  "userGroups": [
    "Public",
    "Graphwise"
  ],
  "description": null,
  "uriSupplement": "New-Test-Project",
  "lastModified": "2026-09-16T12:56:53.873Z",
  "lastOpened": "2026-09-16T12:56:53.873Z",
  "modifiedDate": "2026-09-16T12:56:53.873Z"
}

In this section:

Was this helpful?

Would you like to provide feedback? Just click here to suggest edits.