Oracle® Beehive RESTful Web Services API Reference Release 2 (2.0.1.7) E16658-04 |
URI: /comb/v1/d/labl
HTTP Method: POST
Request Parameters: (expand)
Name | Style | Required | Description |
---|---|---|---|
projection |
Query |
Restricted to:
|
|
accept |
Header |
Restricted to:
|
Directive to the server, indicating the format of the returned payload (or error class) |
runas |
Query |
Identity under-which to execute this operation. Callers require permission to run as a different identity. |
|
suppress_20x_code |
Query |
Restricted to:
|
Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault. |
anticsrf |
Query |
Specifies the anti-CSRF token |
|
content-type |
Header |
Restricted to:
|
The standard HTTP Content-Type Header, indicating the MIME type of the payload |
Request Payload: labelCreator
Response Payload: label
Fault: restFault
Details: (expand)
HTTP Status | Description |
---|---|
Entity already exists | |
Error processing "runas" value | |
Invalid header specified | |
Invalid payload specified | |
Invalid value specified for query parameter | |
JSON payload received with a wrong data member type | |
No payload specified | |
Required header not specified | |
Required query parameter not specified | |
Type of payload specified does not match what is expected | |
Unsupported value in Accept header | |
Internal error occurred |
Sample: (expand)
URI: /comb/v1/d/labl/{id}
HTTP Method: DELETE
Request Parameters: (expand)
Name | Style | Required | Description |
---|---|---|---|
snapshotid |
Query |
determine if the entity should always be deleted or if optimistic locking should be used. |
|
accept |
Header |
Restricted to:
|
Directive to the server, indicating the format of the returned payload (or error class) |
runas |
Query |
Identity under-which to execute this operation. Callers require permission to run as a different identity. |
|
suppress_20x_code |
Query |
Restricted to:
|
Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault. |
anticsrf |
Query |
Specifies the anti-CSRF token |
Request Payload: No Request Payload
Response Payload: No Response Payload
Fault: restFault
Details: (expand)
HTTP Status | Description |
---|---|
Error processing "runas" value | |
Format of ID specified is incorrect | |
Id type is incorrect | |
Invalid value specified for query parameter | |
Required header not specified | |
Required query parameter not specified | |
Unsupported value in Accept header | |
Internal error occurred |
Sample: (expand)
URI: /comb/v1/d/labl/list
HTTP Method: POST
Request Parameters: (expand)
Name | Style | Required | Description |
---|---|---|---|
accept |
Header |
Restricted to:
|
Directive to the server, indicating the format of the returned payload (or error class) |
runas |
Query |
Identity under-which to execute this operation. Callers require permission to run as a different identity. |
|
suppress_20x_code |
Query |
Restricted to:
|
Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault. |
anticsrf |
Query |
Specifies the anti-CSRF token |
|
content-type |
Header |
Restricted to:
|
The standard HTTP Content-Type Header, indicating the MIME type of the payload |
Request Payload: predicateAndSortListParameters
Predicates Supported: (expand)
Sort Criteria Supported: (expand)
Sort Criteria Type |
---|
compoundSortCriteria |
labelAppCountSortCriteria |
modifiedOnSortCriteria |
nameSortCriteria |
Response Payload: listResult<label>
Fault: restFault
Details: (expand)
HTTP Status | Description |
---|---|
Error processing "runas" value | |
Invalid header specified | |
Invalid payload specified | |
Invalid value specified for query parameter | |
JSON payload received with a wrong data member type | |
No payload specified | |
Required header not specified | |
Required query parameter not specified | |
Type of payload specified does not match what is expected | |
Unsupported value in Accept header | |
Internal error occurred |
URI: /comb/v1/d/labl/list/applicationsof/{id}
HTTP Method: GET
Request Parameters: (expand)
Name | Style | Required | Description |
---|---|---|---|
projection |
Query |
Restricted to:
|
|
accept |
Header |
Restricted to:
|
Directive to the server, indicating the format of the returned payload (or error class) |
runas |
Query |
Identity under-which to execute this operation. Callers require permission to run as a different identity. |
|
suppress_20x_code |
Query |
Restricted to:
|
Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault. |
Request Payload: No Request Payload
Response Payload: listResult<labelApplication>
Fault: restFault
Details: (expand)
HTTP Status | Description |
---|---|
Error processing "runas" value | |
Format of ID specified is incorrect | |
Id type is incorrect | |
Invalid value specified for query parameter | |
Required header not specified | |
Unsupported value in Accept header | |
Internal error occurred |
URI: /comb/v1/d/labl/list/entities/{id}
HTTP Method: POST
Request Parameters: (expand)
Name | Style | Required | Description |
---|---|---|---|
accept |
Header |
Restricted to:
|
Directive to the server, indicating the format of the returned payload (or error class) |
runas |
Query |
Identity under-which to execute this operation. Callers require permission to run as a different identity. |
|
suppress_20x_code |
Query |
Restricted to:
|
Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault. |
anticsrf |
Query |
Specifies the anti-CSRF token |
|
content-type |
Header |
Restricted to:
|
The standard HTTP Content-Type Header, indicating the MIME type of the payload |
Request Payload: predicateAndSortListParameters
Predicates Supported: (expand)
Sort Criteria Supported: (expand)
Sort Criteria Type |
---|
appliedOnLabelAppCountSortCriteria |
compoundSortCriteria |
modifiedOnSortCriteria |
nameSortCriteria |
Response Payload: listResult<entity>
Fault: restFault
Details: (expand)
HTTP Status | Description |
---|---|
Error processing "runas" value | |
Format of ID specified is incorrect | |
Id type is incorrect | |
Invalid header specified | |
Invalid payload specified | |
Invalid value specified for query parameter | |
JSON payload received with a wrong data member type | |
No payload specified | |
Required header not specified | |
Required query parameter not specified | |
Type of payload specified does not match what is expected | |
Unsupported value in Accept header | |
Internal error occurred |
URI: /comb/v1/d/labl/{id}
HTTP Method: GET
Request Parameters: (expand)
Name | Style | Required | Description |
---|---|---|---|
projection |
Query |
Restricted to:
|
Projection representing the portion of the Label to load. |
accept |
Header |
Restricted to:
|
Directive to the server, indicating the format of the returned payload (or error class) |
runas |
Query |
Identity under-which to execute this operation. Callers require permission to run as a different identity. |
|
suppress_20x_code |
Query |
Restricted to:
|
Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault. |
Request Payload: No Request Payload
Response Payload: label
Fault: restFault
Details: (expand)
HTTP Status | Description |
---|---|
Error processing "runas" value | |
Format of ID specified is incorrect | |
Id type is incorrect | |
Invalid value specified for query parameter | |
Required header not specified | |
Unsupported value in Accept header | |
Internal error occurred |
Sample: (expand)
URI: /comb/v1/d/labl/ac/{id}
HTTP Method: GET
Request Parameters: (expand)
Name | Style | Required | Description |
---|---|---|---|
accept |
Header |
Restricted to:
|
Directive to the server, indicating the format of the returned payload (or error class) |
runas |
Query |
Identity under-which to execute this operation. Callers require permission to run as a different identity. |
|
suppress_20x_code |
Query |
Restricted to:
|
Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault. |
Request Payload: No Request Payload
Response Payload: accessControlFields
Fault: restFault
Details: (expand)
HTTP Status | Description |
---|---|
Error processing "runas" value | |
Format of ID specified is incorrect | |
Id type is incorrect | |
Invalid value specified for query parameter | |
Required header not specified | |
Unsupported value in Accept header | |
Internal error occurred |
URI: /comb/v1/d/labl/read
HTTP Method: POST
Request Parameters: (expand)
Name | Style | Required | Description |
---|---|---|---|
projection |
Query |
Restricted to:
|
Projection representing the portion to be loaded for each Entity |
accept |
Header |
Restricted to:
|
Directive to the server, indicating the format of the returned payload (or error class) |
runas |
Query |
Identity under-which to execute this operation. Callers require permission to run as a different identity. |
|
suppress_20x_code |
Query |
Restricted to:
|
Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault. |
anticsrf |
Query |
Specifies the anti-CSRF token |
|
content-type |
Header |
Restricted to:
|
The standard HTTP Content-Type Header, indicating the MIME type of the payload |
Request Payload: beeIdList<label>
Fault: restFault
Details: (expand)
HTTP Status | Description |
---|---|
Batch size exceeded | |
Error processing "runas" value | |
Format of ID specified is incorrect | |
Id type is incorrect | |
Invalid header specified | |
Invalid payload specified | |
Invalid value specified for query parameter | |
JSON payload received with a wrong data member type | |
No payload specified | |
Required header not specified | |
Required query parameter not specified | |
Type of payload specified does not match what is expected | |
Unsupported value in Accept header | |
Internal error occurred |
Sample: (expand)
URI: /comb/v1/d/labl/{id}
HTTP Method: PUT
Request Parameters: (expand)
Name | Style | Required | Description |
---|---|---|---|
new_name |
Query |
determine if the entity should always be updated or if optimistic locking should be used. |
|
projection |
Query |
Restricted to:
|
|
accept |
Header |
Restricted to:
|
Directive to the server, indicating the format of the returned payload (or error class) |
runas |
Query |
Identity under-which to execute this operation. Callers require permission to run as a different identity. |
|
suppress_20x_code |
Query |
Restricted to:
|
Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault. |
anticsrf |
Query |
Specifies the anti-CSRF token |
|
content-type |
Header |
Restricted to:
|
The standard HTTP Content-Type Header, indicating the MIME type of the payload |
Request Payload: labelUpdater
Response Payload: label
Fault: restFault
Details: (expand)
HTTP Status | Description |
---|---|
Error processing "runas" value | |
Format of ID specified is incorrect | |
Id type is incorrect | |
Invalid header specified | |
Invalid payload specified | |
Invalid value specified for query parameter | |
JSON payload received with a wrong data member type | |
No payload specified | |
Required header not specified | |
Required query parameter not specified | |
Type of payload specified does not match what is expected | |
Unsupported value in Accept header | |
Internal error occurred |
Sample: (expand)
URI: /comb/v1/d/labl/ac/{id}
HTTP Method: PUT
Request Parameters: (expand)
Name | Style | Required | Description |
---|---|---|---|
accept |
Header |
Restricted to:
|
Directive to the server, indicating the format of the returned payload (or error class) |
runas |
Query |
Identity under-which to execute this operation. Callers require permission to run as a different identity. |
|
suppress_20x_code |
Query |
Restricted to:
|
Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault. |
anticsrf |
Query |
Specifies the anti-CSRF token |
|
content-type |
Header |
Restricted to:
|
The standard HTTP Content-Type Header, indicating the MIME type of the payload |
Request Payload: accessControlFieldsUpdater
Response Payload: No Response Payload
Fault: restFault
Details: (expand)
HTTP Status | Description |
---|---|
Error processing "runas" value | |
Format of ID specified is incorrect | |
Id type is incorrect | |
Invalid header specified | |
Invalid payload specified | |
Invalid value specified for query parameter | |
JSON payload received with a wrong data member type | |
No payload specified | |
Required header not specified | |
Required query parameter not specified | |
Type of payload specified does not match what is expected | |
Unsupported value in Accept header | |
Internal error occurred |
Copyright © 2008, 2012, Oracle and/or its affiliates. All rights reserved.
Legal Notices