Resource for handling ContentRepository Fragments
List available ContentRepository Fragments.
The result can be filtered by
id
globalId
name
id
globalId
name
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 |
perms | query | Flag to add permission information for the returned items. | false | boolean |
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 | ContentRepository Fragment list is returned. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | ContentRepositoryFragmentListResponse (JSON) | List of ContentRepository Fragments |
GET /cr_fragments
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ {
"id" : 12345,
"name" : "...",
"globalId" : "..."
}, {
"id" : 12345,
"name" : "...",
"globalId" : "..."
} ],
"hasMoreItems" : true,
"numItems" : 12345,
"perms" : {
"property1" : [ "formreport", "create" ],
"property2" : [ "formreport", "createitems" ]
},
"stagingStatus" : {
"property1" : {
"packageName" : "...",
"included" : true
},
"property2" : {
"packageName" : "...",
"included" : true
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Create a new ContentRepository Fragment
media type | data type | description |
---|---|---|
application/json | ContentRepositoryFragmentModel (JSON) | ContentRepository Fragment to create |
code | condition |
---|---|
201 | ContentRepository Fragment was created. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | ContentRepositoryFragmentResponse (JSON) | created ContentRepository Fragment |
POST /cr_fragments
Content-Type: application/json
Accept: application/json
{
"id" : 12345,
"name" : "...",
"globalId" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"contentRepositoryFragment" : {
"id" : 12345,
"name" : "...",
"globalId" : "..."
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Delete the ContentRepository Fragment with given id
name | type | description |
---|---|---|
id | path | internal or external ContentRepository Fragment ID |
code | condition |
---|---|
204 | ContentRepository Fragment {id} was deleted. |
404 | ContentRepository Fragment {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 | object (JSON) | response |
DELETE /cr_fragments/{id}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 204 No Content
Content-Type: application/json
...
Get the ContentRepository Fragment with given id
name | type | description |
---|---|---|
id | path | internal or external ContentRepository ID |
code | condition |
---|---|
200 | ContentRepository Fragment {id} exists. |
404 | ContentRepository Fragment {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 | ContentRepositoryFragmentResponse (JSON) | Response containing the ContentRepository |
GET /cr_fragments/{id}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"contentRepositoryFragment" : {
"id" : 12345,
"name" : "...",
"globalId" : "..."
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Update ContentRepository Fragment with given id
name | type | description |
---|---|---|
id | path | internal or external ContentRepository Fragment ID |
media type | data type | description |
---|---|---|
application/json | ContentRepositoryFragmentModel (JSON) | updated ContentRepository Fragment |
code | condition |
---|---|
201 | ContentRepository Fragment {id} was updated. |
404 | ContentRepository Fragment {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 | ContentRepositoryFragmentResponse (JSON) | updated ContentRepository Fragment |
PUT /cr_fragments/{id}
Content-Type: application/json
Accept: application/json
{
"id" : 12345,
"name" : "...",
"globalId" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"contentRepositoryFragment" : {
"id" : 12345,
"name" : "...",
"globalId" : "..."
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get the entries in the ContentRepository Fragment.
The result can be filtered by
id
globalId
tagname
mapname
foreignlinkAttribute
foreignlinkAttributeRule
category
id
globalId
tagname
mapname
objType
attributeType
targetType
multivalue
optimized
filesystem
foreignlinkAttribute
foreignlinkAttributeRule
category
segmentfield
displayfield
urlfield
name | type | description | default | constraints |
---|---|---|---|---|
id | path | internal or external 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 | List of entries in ContentRepository Fragment {id} is returned. |
404 | ContentRepository Fragment {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 | ContentRepositoryFragmentEntryListResponse (JSON) | list of entries |
GET /cr_fragments/{id}/entries
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ { }, { } ],
"hasMoreItems" : true,
"numItems" : 12345,
"perms" : {
"property1" : [ "updateinheritance", "deleteform" ],
"property2" : [ "edit", "publish" ]
},
"stagingStatus" : {
"property1" : {
"packageName" : "...",
"included" : true
},
"property2" : {
"packageName" : "...",
"included" : true
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Create a new ContentRepository Fragment Entry
name | type | description |
---|---|---|
id | path | internal or external ID of the ContentRepository Fragment |
media type | data type | description |
---|---|---|
application/json | ContentRepositoryFragmentEntryModel (JSON) | entry to create |
code | condition |
---|---|
201 | Entry was created. |
404 | ContentRepository Fragment {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 | ContentRepositoryFragmentEntryResponse (JSON) | created entry |
POST /cr_fragments/{id}/entries
Content-Type: application/json
Accept: application/json
{
"id" : 12345,
"globalId" : "...",
"tagname" : "...",
"mapname" : "...",
"objType" : 12345,
"attributeType" : 12345,
"multivalue" : true,
"optimized" : true,
"filesystem" : true,
"targetType" : 12345,
"foreignlinkAttribute" : "...",
"foreignlinkAttributeRule" : "...",
"category" : "...",
"displayfield" : true,
"segmentfield" : true,
"urlfield" : true,
"elasticsearch" : { },
"micronodeFilter" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"entry" : {
"id" : 12345,
"globalId" : "...",
"tagname" : "...",
"mapname" : "...",
"objType" : 12345,
"attributeType" : 12345,
"multivalue" : true,
"optimized" : true,
"filesystem" : true,
"targetType" : 12345,
"foreignlinkAttribute" : "...",
"foreignlinkAttributeRule" : "...",
"category" : "...",
"displayfield" : true,
"segmentfield" : true,
"urlfield" : true,
"elasticsearch" : { },
"micronodeFilter" : "..."
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Delete the Fragment entry
name | type | description |
---|---|---|
entryId | path | internal or external entry ID |
id | path | internal or external ContentRepository Fragment ID |
code | condition |
---|---|
204 | Entry {entryId} was deleted. |
404 | ContentRepository Fragment {id} 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) | response |
DELETE /cr_fragments/{id}/entries/{entryId}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 204 No Content
Content-Type: application/json
...
Get a Fragment Entry
name | type | description |
---|---|---|
entryId | path | internal or external ID of the entry |
id | path | internal or external ID of the ContentRepository Fragment |
code | condition |
---|---|
200 | Entry {entryId} is returned. |
404 | ContentRepository {id} 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 | ContentRepositoryFragmentEntryResponse (JSON) | response containing the entry |
GET /cr_fragments/{id}/entries/{entryId}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"entry" : {
"id" : 12345,
"globalId" : "...",
"tagname" : "...",
"mapname" : "...",
"objType" : 12345,
"attributeType" : 12345,
"multivalue" : true,
"optimized" : true,
"filesystem" : true,
"targetType" : 12345,
"foreignlinkAttribute" : "...",
"foreignlinkAttributeRule" : "...",
"category" : "...",
"displayfield" : true,
"segmentfield" : true,
"urlfield" : true,
"elasticsearch" : { },
"micronodeFilter" : "..."
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Update Fragment entry
name | type | description |
---|---|---|
entryId | path | internal or external entry ID |
id | path | internal or external ContentRepository Fragment ID |
media type | data type | description |
---|---|---|
application/json | ContentRepositoryFragmentEntryModel (JSON) | updated entry |
code | condition |
---|---|
201 | Entry {entryId} was updated. |
404 | ContentRepository Fragment {id} 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 | ContentRepositoryFragmentEntryResponse (JSON) | updated entry |
PUT /cr_fragments/{id}/entries/{entryId}
Content-Type: application/json
Accept: application/json
{
"id" : 12345,
"globalId" : "...",
"tagname" : "...",
"mapname" : "...",
"objType" : 12345,
"attributeType" : 12345,
"multivalue" : true,
"optimized" : true,
"filesystem" : true,
"targetType" : 12345,
"foreignlinkAttribute" : "...",
"foreignlinkAttributeRule" : "...",
"category" : "...",
"displayfield" : true,
"segmentfield" : true,
"urlfield" : true,
"elasticsearch" : { },
"micronodeFilter" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"entry" : {
"id" : 12345,
"globalId" : "...",
"tagname" : "...",
"mapname" : "...",
"objType" : 12345,
"attributeType" : 12345,
"multivalue" : true,
"optimized" : true,
"filesystem" : true,
"targetType" : 12345,
"foreignlinkAttribute" : "...",
"foreignlinkAttributeRule" : "...",
"category" : "...",
"displayfield" : true,
"segmentfield" : true,
"urlfield" : true,
"elasticsearch" : { },
"micronodeFilter" : "..."
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}