Resource for handling ContentRepository Fragments
List available ContentRepository Fragments
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 | 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 |
application/xml | (custom) |
GET /cr_fragments Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ { }, { } ],
"hasMoreItems" : true,
"numItems" : 12345,
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "INFO",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "NEUTRAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "NOTFOUND",
"responseMessage" : "...",
"property" : "..."
}
}
Create a new ContentRepository Fragment
media type | data type | description |
---|---|---|
application/json | ContentRepositoryFragmentModel (JSON) | ContentRepository Fragment to create |
application/xml | (custom) |
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 |
application/xml | (custom) |
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" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "CRITICAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "NEUTRAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "FAILURE",
"responseMessage" : "...",
"property" : "..."
}
}
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 |
application/xml | (custom) |
GET /cr_fragments/{id} Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"contentRepositoryFragment" : {
"id" : 12345,
"name" : "...",
"globalId" : "..."
},
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "CRITICAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "CRITICAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "INVALIDDATA",
"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 |
application/xml | (custom) |
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 |
application/xml | (custom) |
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" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "INFO",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "SUCCESS",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"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 |
application/xml | (custom) |
DELETE /cr_fragments/{id} Accept: application/json
HTTP/1.1 204 No Content
Content-Type: application/json
...
Get the entries in the ContentRepository Fragment
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 |
application/xml | (custom) |
GET /cr_fragments/{id}/entries Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ { }, { } ],
"hasMoreItems" : true,
"numItems" : 12345,
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "INFO",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "NEUTRAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "AUTHREQUIRED",
"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 |
application/xml | (custom) |
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 |
application/xml | (custom) |
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" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "CRITICAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "CRITICAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "NOTFOUND",
"responseMessage" : "...",
"property" : "..."
}
}
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 |
application/xml | (custom) |
GET /cr_fragments/{id}/entries/{entryId} 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" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "SUCCESS",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "CRITICAL",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "AUTHREQUIRED",
"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 |
application/xml | (custom) |
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 |
application/xml | (custom) |
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" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "WARNING",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "INFO",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"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 |
application/xml | (custom) |
DELETE /cr_fragments/{id}/entries/{entryId} Accept: application/json
HTTP/1.1 204 No Content
Content-Type: application/json
...