MachineAccount



[tags: RPRM]

Resource Root

https://localhost:8443/api/rest/machine-accounts

Summary


Resources Methods
https://localhost:8443/api/rest/machine-accounts

GET  Retrieves a list of machine-accounts.

POST  Creates a local machine-account account.

https://localhost:8443/api/rest/machine-accounts/{value}

GET  Retrieves information about a machine-account account.

DELETE  Deletes information about a local machine-account account [tags: RPRM] .

PUT  Updates information about a machine-account account.

Resources


https://localhost:8443/api/rest/machine-accounts


Methods

GET


Retrieves a list of machine-accounts.
[tags: RPRM]

Response

Status Representation Description
200 application/vnd.plcm.plcm-machine-account-list+xml
application/vnd.plcm.plcm-machine-account-list+json
Machine-account information successfully retrieved
304
Machine-account information has not changed since the last search.

Note: The API client must provide the "plcm-machine-account-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-machine-account-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
machine-accounts on the server.
403 application/vnd.plcm.plcm-error+xml
Current user does not have permission to request information.

POST


Creates a local machine-account account.
[tags: RPRM]

Request

Representations

application/vnd.plcm.plcm-machine-account+xml
application/vnd.plcm.plcm-machine-account+json

Response

Status Representation Description
201 Machine-account created successfully.
400 text/plain
Bad request.
409 application/vnd.plcm.plcm-error+xml
The machine-account already exists.
409 application/vnd.plcm.plcm-error+xml
Machine-account name is required.
409 application/vnd.plcm.plcm-error+xml
Lock machine-account operation is not supported.
409 application/vnd.plcm.plcm-error+xml
Could not add machine-account because duplicate owner.

https://localhost:8443/api/rest/machine-accounts/{value}


Template Parameters

Name Type Description
value xs:string the uuid of machine-account

Methods

GET


Retrieves information about a machine-account account.
[tags: RPRM]

Response

Status Representation Description
200 application/vnd.plcm.plcm-machine-account+xml
application/vnd.plcm.plcm-machine-account+json
Machine-account information successfully retrieved.
304
Machine-account information has not changed since the last retrieval.
Note: The API client must provide the "plcm-machine-account" 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 single machine-account retrieval in the "If-None-Match" header, then
the HTTP response will contain the machine-account representation in the message
body.

The "plcm-machine-account" ETag can be accessed from the initial retrieval result's HTTP
response header. Also, subsequent retrievals require the identical domain and
machine-account name to ensure an equivalent ETag value. This also assumes no other client made changes to
machine-accounts on the server.
404 application/vnd.plcm.plcm-error+xml
No such machine-account

DELETE


Deletes information about a local machine-account account
[tags: RPRM]

Response

Status Representation Description
204 Machine-account information successfully deleted
404 application/vnd.plcm.plcm-error+xml
No such machine-account.

PUT


Updates information about a machine-account account.
[tags: RPRM]

Request

Representations

application/vnd.plcm.plcm-machine-account+xml
application/vnd.plcm.plcm-machine-account+json

Response

Status Representation Description
204
Machine-account information successfully updated.
Note: The response will only contain both an ETag value
and link to the updated machine-account resource.
400 text/plain
Bad request.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission. User roles required: administrator, provisioner
404 application/vnd.plcm.plcm-error+xml
No such machine-account.
412 application/vnd.plcm.plcm-error+xml

The machine-account resource has changed on the server.

Note: The response will contain the ETag value and link that reflects
the server's machine-account resource in the HTTP response header.

The API client must supply the ETag in the message body that is bounded by
the "entity-tag" XML tag. Refer to the "plcm-machine-account.xsd" for details.
If the message body does not contain the ETag value, the server will
look for the ETag in the "If-Match" header.
428 application/vnd.plcm.plcm-error+xml

The API client must supply the ETag in the message body that is bounded by
the "entity-tag" XML tag. Refer to the "plcm-machine-account.xsd" for details.
If the message body does not contain the ETag value, the server will
look for the ETag in the "If-Match" header.