Content Server



[tags: DMA]

Resource Root

https://localhost:8443/api/rest/content-servers

Summary


Resources Methods
https://localhost:8443/api/rest/content-servers

https://localhost:8443/api/rest/content-servers/config

GET Retrieves content servers.

POST  Creates a content server.

https://localhost:8443/api/rest/content-servers/config/{content-server-identifier}

GET Retrieves a content server.

PUT  Updates a content server.

DELETE Deletes a content server.

https://localhost:8443/api/rest/content-servers/status

GET Retrieves content servers.

https://localhost:8443/api/rest/content-servers/status/{content-server-identifier}

GET Retrieves a content server.

Resources


https://localhost:8443/api/rest/content-servers


https://localhost:8443/api/rest/content-servers/config


Methods

GET

Retrieves content servers. [tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-content-server-list+xml
application/vnd.plcm.plcm-content-server-list+json
Information successfully retrieved.
304
Content server information has not changed since the last search.

Note: The API client must provide the "plcm-content-server-list" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval.
This will improve network performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous, identical
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.

The "plcm-content-server-list" ETag can be accessed from the initial search result's HTTP
response header. Also, subsequent searches require the identical search filter
to ensure an equivalent ETag value. This also assumes no other client made changes to
content servers on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator

POST


Creates a content server. Any submitted ID is ignored. The ID is assigned by the system.

DMA roles required: administrator

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-content-server+xml
application/vnd.plcm.plcm-content-server+json

Response

Status Representation Description
201
Content server created successfully. The ETag returned in the HTTP header represents the version
of the content server.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Bad request.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unauthorized. DMA roles required: administrator
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator

https://localhost:8443/api/rest/content-servers/config/{content-server-identifier}


Template Parameters

Name Type Description
value xs:string
Unique identifier of the content server.

[tags: DMA]

Methods

GET

Retrieves a content server. [tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-content-server+xml
application/vnd.plcm.plcm-content-server+json
Information successfully retrieved.
304
Content server information has not changed since the last search.

Note: The API client must provide the "plcm-content-server" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval.
This will improve network performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous, identical
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.

The "plcm-content-server" ETag can be accessed from the initial search result's HTTP
response header. Also, subsequent searches require the identical search filter
to ensure an equivalent ETag value. This also assumes no other client made changes to
the content servers on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
There is no content server with the identifier supplied in the URL.

PUT


Updates a content server.

DMA roles required: administrator

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-content-server+xml
application/vnd.plcm.plcm-content-server+json

Response

Status Representation Description
204
Content server updated successfully. The ETag returned in the HTTP header represents the version
of the content server.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Bad request.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unauthorized. DMA roles required: administrator
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
There is no content server with the identifier supplied in the URL.
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The ETag supplied in the header and/or body does not match that on the server.
This usually means that the content server upon which the update is based has changed
since the last time you accessed it.
428 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The ETag is missing and required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The ETag in the header does not match that in the body
Only one of these is required but if they are both supplied they must match.

DELETE

Deletes a content server. [tags: DMA]

Response

Status Representation Description
204 Content server deleted successfully.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Bad request.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unauthorized. DMA roles required: administrator
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
There is no content server with the identifier supplied in the URL.

https://localhost:8443/api/rest/content-servers/status


Methods

GET

Retrieves content servers. [tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-content-server-list+xml
application/vnd.plcm.plcm-content-server-list+json
Information successfully retrieved.
304
Content server information has not changed since the last search.

Note: The API client must provide the "plcm-content-server-list" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval.
This will improve network performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous, identical
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.

The "plcm-content-server-list" ETag can be accessed from the initial search result's HTTP
response header. Also, subsequent searches require the identical search filter
to ensure an equivalent ETag value. This also assumes no other client made changes to
content servers on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator

https://localhost:8443/api/rest/content-servers/status/{content-server-identifier}


Methods

GET

Retrieves a content server. [tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-content-server+xml
application/vnd.plcm.plcm-content-server+json
Information successfully retrieved.
304
Content server information has not changed since the last search.

Note: The API client must provide the "plcm-content-server" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval.
This will improve network performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous, identical
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.

The "plcm-content-server" ETag can be accessed from the initial search result's HTTP
response header. Also, subsequent searches require the identical search filter
to ensure an equivalent ETag value. This also assumes no other client made changes to
the content servers on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
There is no content server with the identifier supplied in the URL.