Enterprise Group



[tags: DMA]

Resource Root

https://localhost:8443/api/rest/enterprise-groups

Summary


Resources Methods
https://localhost:8443/api/rest/enterprise-groups

GET Retrieves imported enterprise groups.

https://localhost:8443/api/rest/enterprise-groups/{enterprise-group-identifier}

GET Retrieves an imported enterprise group.

PUT .

DELETE Deletes an imported enterprise group.

https://localhost:8443/api/rest/enterprise-groups/import

GET Retrieves a list of enterprise groups that may be imported based on optional search parameters.

POST Imports the specified enterprise groups.

Resources


https://localhost:8443/api/rest/enterprise-groups


Methods

GET

Retrieves imported enterprise groups. [tags: DMA]

Request

Response

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

Note: The API client must provide the "plcm-enterprise-group-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-enterprise-group-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
the enterprise groups on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator, provisioner

https://localhost:8443/api/rest/enterprise-groups/{enterprise-group-identifier}


Template Parameters

Name Type Description
enterprise-group-identifier xs:string
Unique identifier of the enterprise group.

[tags: DMA]

Methods

GET

Retrieves an imported enterprise group. [tags: DMA]

Response

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

Note: The API client must provide the "plcm-enterprise-group" 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-enterprise-group" 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 enterprise group on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator, provisioner
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
There is no enterprise group with the identifier supplied in the URL.

PUT

Request

Representations

application/vnd.plcm.plcm-enterprise-group+xml

Response

Status Representation Description
204
Enterprise group updated successfully. The ETag returned in the HTTP header represents the current version
of the enterprise group.
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, provisioner
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator, provisioner
409 application/vnd.plcm.plcm-error+xml
An override-default field was false but the corresponding field was specified with a value other than the default.
409 application/vnd.plcm.plcm-error+xml
An override-default field was true but the corresponding field was not specified.
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 factory 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 an imported enterprise group. [tags: DMA]

Response

Status Representation Description
204 Enterprise group 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, provisioner
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator, provisioner
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
There is no enterprise group with the identifier supplied in the URL.

https://localhost:8443/api/rest/enterprise-groups/import


Methods

GET

Retrieves a list of enterprise groups that may be imported based on optional search parameters. [tags: DMA]

Request

Query Parameters

Name Type Description
domain xs:string
Search for enterprise groups within this domain.
name xs:string
Filter to enterprise groups whose name matches this partial value.

Response

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

Note: The API client must provide the "plcm-enterprise-group-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-enterprise-group-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
the enterprise groups on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator, provisioner

POST

Imports the specified enterprise groups. [tags: DMA]

Request

Representations

application/vnd.plcm.plcm-enterprise-group-list+xml

Response

Status Representation Description
204 Enterprise Groups successfully imported
400 text/plain
Bad request.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator, provisioner
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
One or more of the specified enterprise groups was not found.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
An enterprise group with the same name already exists.