Web Service Method: Create a New Collection

Description

Creates a new collection.

URL: /PoolParty/api/thesaurus/{project}/createCollection

Request

Supported Methods

POST

Content-Type

application/x-www-form-urlencoded

Path Variables

Variable

Comment

{project}

The UUID or the URI supplement (textual identifier) of the project to be used.

HTTP Parameters

Parameter

Comment

Type

Required

title

Collection title

String

true

isordered

Indicates, whether order of collection members is relevant

boolean

true

description

Description of the collection

String

false

Response

http status code 200if OK.

String containing URL of the newly created collection.

URL Pattern

POST Request

http://<server-url>/PoolParty/api/thesaurus/<project-Id>/createCollection?title=my API collection&isordered=false&descritpion=A collection, created via API

Response

http://<server-url>/<project-id>/<created-collection-id>