This concept is mutated by Ckan which is used as underling technology to persist items. Only Catalogue-Admins or above are able to invoke non-safe methods.
name | type | description | default | constraints |
---|---|---|---|---|
Authorization | header | Bearer token, see https://dev.d4science.org/how-to-access-resources | ||
count | query | false | boolean | |
limit | query | 10 | int | |
offset | query | 0 | int |
media type | data type | description |
---|---|---|
application/json;charset=UTF-8 | string |
GET /organizations
Content-Type: */*
Accept: application/json;charset=UTF-8
Authorization: ...
...
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
...
An Organization is mainly described by the following attributes (* indicate mandatory attributes):
name | type | description |
---|---|---|
Authorization | header | Bearer token, see https://dev.d4science.org/how-to-access-resources |
media type | data type |
---|---|
application/json;charset=UTF-8 | string |
media type | data type | description |
---|---|---|
application/json;charset=UTF-8 | object |
POST /organizations
Content-Type: application/json;charset=UTF-8
Accept: application/json;charset=UTF-8
Authorization: ...
...
HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8
...
name | type | description | default | constraints |
---|---|---|---|---|
Authorization | header | Bearer token, see https://dev.d4science.org/how-to-access-resources | ||
ORGANIZATION_ID | path | |||
purge | query | false | boolean |
media type | data type | description |
---|---|---|
*/* | object |
DELETE /organizations/{ORGANIZATION_ID}
Content-Type: */*
Accept: */*
Authorization: ...
...
HTTP/1.1 204 No Content
Content-Type: */*
...
name | type | description |
---|---|---|
Authorization | header | Bearer token, see https://dev.d4science.org/how-to-access-resources |
ORGANIZATION_ID | path |
media type | data type | description |
---|---|---|
application/json;charset=UTF-8 | string |
GET /organizations/{ORGANIZATION_ID}
Content-Type: */*
Accept: application/json;charset=UTF-8
Authorization: ...
...
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
...
name | type | description |
---|---|---|
Authorization | header | Bearer token, see https://dev.d4science.org/how-to-access-resources |
ORGANIZATION_ID | path |
media type | data type |
---|---|
application/json;charset=UTF-8 | string |
media type | data type | description |
---|---|---|
application/json;charset=UTF-8 | string |
PATCH /organizations/{ORGANIZATION_ID}
Content-Type: application/json;charset=UTF-8
Accept: application/json;charset=UTF-8
Authorization: ...
...
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
...
name | type | description |
---|---|---|
Authorization | header | Bearer token, see https://dev.d4science.org/how-to-access-resources |
ORGANIZATION_ID | path |
media type | data type | description |
---|---|---|
*/* | object |
PURGE /organizations/{ORGANIZATION_ID}
Content-Type: */*
Accept: */*
Authorization: ...
...
HTTP/1.1 200 OK
Content-Type: */*
...
name | type | description |
---|---|---|
Authorization | header | Bearer token, see https://dev.d4science.org/how-to-access-resources |
ORGANIZATION_ID | path |
media type | data type |
---|---|
application/json;charset=UTF-8 | string |
media type | data type | description |
---|---|---|
application/json;charset=UTF-8 | string |
PUT /organizations/{ORGANIZATION_ID}
Content-Type: application/json;charset=UTF-8
Accept: application/json;charset=UTF-8
Authorization: ...
...
HTTP/1.1 204 No Content
Content-Type: application/json;charset=UTF-8
...