Resource for management of datasources
List datasources.
The result can be filtered by
id
globalId
name
type
id
globalId
name
type
name | type | description | default | constraints |
---|---|---|---|---|
page | query | Returned page, if paging is used. Paging starts with 1 |
1 | int |
pageSize | query | Page size for paging. If this is set to -1 no paging is used (all matching items are returned).
Setting this to 0 will return no items. |
-1 | int |
q | query | Query string for filtering | ||
sort | query | Comma separated list of sorted attributes.
Each attribute name may be prefixed with + for sorting in ascending order or - for sorting in descending order |
name |
code | condition |
---|---|
200 | List of datasources is returned. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | PagedDatasourceListResponse (JSON) | response containing a list of datasources |
GET /datasource
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ { }, { } ],
"hasMoreItems" : true,
"numItems" : 12345,
"perms" : {
"property1" : [ "updatetemplates", "inheritance" ],
"property2" : [ "createitems", "updateform" ]
},
"stagingStatus" : {
"property1" : {
"packageName" : "...",
"included" : true
},
"property2" : {
"packageName" : "...",
"included" : true
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Create new datasource
media type | data type | description |
---|---|---|
application/json | Datasource (JSON) | datasource |
code | condition |
---|---|
200 | Datasource was created. |
400 | No request body was sent. |
400 | Not all required fields had non-null values. |
409 | The given name is already in use by another datasource. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | DatasourceLoadResponse (JSON) | response containing created datasource |
POST /datasource
Content-Type: application/json
Accept: application/json
{
"id" : 12345,
"globalId" : "...",
"type" : "SITEMINDER",
"name" : "..."
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"datasource" : {
"id" : 12345,
"globalId" : "...",
"type" : "STATIC",
"name" : "..."
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Delete a datasource
name | type | description |
---|---|---|
id | path | datasource ID |
code | condition |
---|---|
204 | Datasource {id} was deleted. |
404 | Datasource {id} does not exist. |
409 | Datasource {id} cannot be deleted, because it is used. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | empty response |
DELETE /datasource/{id}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 204 No Content
Content-Type: application/json
...
Get existing datasource
name | type | description |
---|---|---|
id | path | datasource ID |
code | condition |
---|---|
200 | Datasource {id} exists. |
404 | Datasource {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | DatasourceLoadResponse (JSON) | response containing the datasource |
GET /datasource/{id}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"datasource" : {
"id" : 12345,
"globalId" : "...",
"type" : "STATIC",
"name" : "..."
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Update a datasource
name | type | description |
---|---|---|
id | path | datasource ID |
media type | data type | description |
---|---|---|
application/json | Datasource (JSON) | updated datasource data |
code | condition |
---|---|
200 | Datasource {id} was updated. |
400 | No request body was sent. |
404 | Datasource {id} does not exist. |
409 | The given name is already in use by another datasource. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | DatasourceLoadResponse (JSON) | response containing the updated datasource |
PUT /datasource/{id}
Content-Type: application/json
Accept: application/json
{
"id" : 12345,
"globalId" : "...",
"type" : "SITEMINDER",
"name" : "..."
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"datasource" : {
"id" : 12345,
"globalId" : "...",
"type" : "STATIC",
"name" : "..."
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get the constructs using the datasource.
The result can be filtered by
id
globalId
keyword
name
description
category
id
globalId
keyword
name
description
category
name | type | description | default | constraints |
---|---|---|---|---|
id | path | datasource id | ||
page | query | Returned page, if paging is used. Paging starts with 1 |
1 | int |
pageSize | query | Page size for paging. If this is set to -1 no paging is used (all matching items are returned).
Setting this to 0 will return no items. |
-1 | int |
q | query | Query string for filtering | ||
sort | query | Comma separated list of sorted attributes.
Each attribute name may be prefixed with + for sorting in ascending order or - for sorting in descending order |
name |
code | condition |
---|---|
200 | Datasource {id} exists. |
404 | Datasource {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | ConstructList (JSON) | response containing a list of constructs using the datasource |
GET /datasource/{id}/constructs
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ { }, { } ],
"hasMoreItems" : true,
"numItems" : 12345,
"perms" : {
"property1" : [ "publish", "deleteform" ],
"property2" : [ "userassignment", "createitems" ]
},
"stagingStatus" : {
"property1" : {
"packageName" : "...",
"included" : true
},
"property2" : {
"packageName" : "...",
"included" : true
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
List entries of a datasource
name | type | description |
---|---|---|
id | path | datasource id |
code | condition |
---|---|
200 | List of entries is returned. |
404 | Datasource {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | DatasourceEntryListResponse (JSON) | response containing a list of entries |
GET /datasource/{id}/entries
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ { }, { } ],
"hasMoreItems" : true,
"numItems" : 12345,
"perms" : {
"property1" : [ "read", "createoverview" ],
"property2" : [ "linktemplates", "createitems" ]
},
"stagingStatus" : {
"property1" : {
"packageName" : "...",
"included" : true
},
"property2" : {
"packageName" : "...",
"included" : true
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Create a datasource entry in the datasource
name | type | description |
---|---|---|
id | path | datasource id |
media type | data type | description |
---|---|---|
application/json | DatasourceEntryModel (JSON) | datasource entry |
code | condition |
---|---|
200 | Entry was created. |
400 | No request body was sent. |
400 | Not all required fields had non-null values. |
404 | Datasource {id} does not exist. |
409 | One of the given values is already used by another entry. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | DatasourceEntryResponse (JSON) | response containing the created entry |
POST /datasource/{id}/entries
Content-Type: application/json
Accept: application/json
{
"id" : 12345,
"globalId" : "...",
"dsId" : 12345,
"key" : "...",
"value" : "..."
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"entry" : {
"id" : 12345,
"globalId" : "...",
"dsId" : 12345,
"key" : "...",
"value" : "..."
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Update the entries in the given order
name | type | description |
---|---|---|
id | path | datasource id |
media type | data type | description |
---|---|---|
application/json | array of DatasourceEntryModel (JSON) | list of entries |
code | condition |
---|---|
200 | Entry {entryId} was updated. |
400 | No request body was sent. |
404 | Datasource {id} does not exist or entry {entryId} does not exist. |
409 | Some entry data violate the uniqueness constraint. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | DatasourceEntryListResponse (JSON) | response containing the list of updated entries |
PUT /datasource/{id}/entries
Content-Type: application/json
Accept: application/json
[ {
"id" : 12345,
"globalId" : "...",
"dsId" : 12345,
"key" : "...",
"value" : "..."
} ]
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ { }, { } ],
"hasMoreItems" : true,
"numItems" : 12345,
"perms" : {
"property1" : [ "updateitems", "publishform" ],
"property2" : [ "updateitems", "read" ]
},
"stagingStatus" : {
"property1" : {
"packageName" : "...",
"included" : true
},
"property2" : {
"packageName" : "...",
"included" : true
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get the implementation hash for a datasource
name | type | description |
---|---|---|
id | path | datasource ID |
code | condition |
---|---|
200 | Datasource {id} exists. |
404 | Datasource {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | ImplementationHashResponse (JSON) | response with implementation hash |
GET /datasource/{id}/hash
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"hash" : "...",
"base" : "...",
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Delete a datasource entry
name | type | description |
---|---|---|
entryId | path | datasource entry id |
id | path | datasource id |
code | condition |
---|---|
204 | Entry {entryId} was deleted. |
404 | Datasource {id} does not exist or entry {entryId} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | empty response |
DELETE /datasource/{id}/entries/{entryId}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 204 No Content
Content-Type: application/json
...
Get existing datasource entry
name | type | description |
---|---|---|
entryId | path | datasource entry id |
id | path | datasource id |
code | condition |
---|---|
200 | Entry {entryId} is returned. |
404 | Datasource {id} does not exist or entry {entryId} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | DatasourceEntryResponse (JSON) | response containing the entry |
GET /datasource/{id}/entries/{entryId}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"entry" : {
"id" : 12345,
"globalId" : "...",
"dsId" : 12345,
"key" : "...",
"value" : "..."
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Update a datasource entry
name | type | description |
---|---|---|
entryId | path | datasource entry id |
id | path | datasource id |
media type | data type | description |
---|---|---|
application/json | DatasourceEntryModel (JSON) | updated entry |
code | condition |
---|---|
200 | Entry {entryId} was updated. |
400 | No request body was sent. |
404 | Datasource {id} does not exist or entry {entryId} does not exist. |
409 | One of the given values is already used by another entry. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | DatasourceEntryResponse (JSON) | response containing the updated entry |
PUT /datasource/{id}/entries/{entryId}
Content-Type: application/json
Accept: application/json
{
"id" : 12345,
"globalId" : "...",
"dsId" : 12345,
"key" : "...",
"value" : "..."
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"entry" : {
"id" : 12345,
"globalId" : "...",
"dsId" : 12345,
"key" : "...",
"value" : "..."
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}