Oracle Beehive
  Oracle® Beehive RESTful Web Services API Reference
  Release 2 (2.0.1.7)
  E16658-04

Contents

Session Utilities

Login and logout utilities

Anti-CSRF Token

Gets the Anti-CSRF token. This token is required as a query parameter on any call that uses the HTTP POST, PUT or DELETE methods.

URI: /comb/v1/d/session/anticsrf

HTTP Method: GET

Request Parameters: (expand)

Name Style Required Description

runas

Query

Identity under-which to execute this operation. Callers require permission to run as a different identity.

accept

Header

Restricted to:

  • application/json
  • application/xml

Directive to the server, indicating the format of the returned payload (or error class)

Request Payload: No Request Payload

Response Payload: antiCSRF

Fault: restFault

Details: (expand)

HTTP Status Description
500
Internal error occurred

Login

Logs in the user and sets up a session without performing any other operation. This method retuns the Anti-CSRF token which should specified as a parameter on all further calls that use the HTTP POST, PUT or DELETE methods.

URI: /comb/v1/d/session/login

HTTP Method: POST

Request Parameters: (expand)

Name Style Required Description

runas

Query

Identity under-which to execute this operation. Callers require permission to run as a different identity.

accept

Header

Restricted to:

  • application/json
  • application/xml

Directive to the server, indicating the format of the returned payload (or error class)

suppress_20x_code

Query

Restricted to:

  • false
  • true

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: antiCSRF

Fault: restFault

Details: (expand)

HTTP Status Description
500
Internal error occurred

Logout

Logout User. This is used in conjunction with the "runas" feature, where a single HTTP session may represent multiple users data. The logout call frees server resources associated with either the current user, or the user associated with the "runas" value in the header

URI: /comb/v1/d/session/logout

HTTP Method: POST

Request Parameters: (expand)

Name Style Required Description

runas

Query

Identity under-which to execute this operation. Callers require permission to run as a different identity.

accept

Header

Restricted to:

  • application/json
  • application/xml

Directive to the server, indicating the format of the returned payload (or error class)

suppress_20x_code

Query

Restricted to:

  • false
  • true

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
500
Internal error occurred

Pending Event Notifications

Retreives pending event notifications for the current user. Note that if the queue of notifications has reached its capacity, then the queue is cleared and the only event in the queue will be a "queueOverflowEvent". Until this event has been dequeued by the client, no other events are enqueued for this session.

URI: /comb/v1/d/session/events

HTTP Method: POST

Request Parameters: (expand)

Name Style Required Description

accept

Header

Restricted to:

  • application/json
  • application/xml

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:

  • false
  • true

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: list<changeEvent>

Fault: restFault

Details: (expand)

HTTP Status Description
400
Error processing "runas" value
400
Required header not specified
406
Unsupported value in Accept header
500
Internal error occurred

Subscribe

Subscribes to notifications from single entity.

URI: /comb/v1/d/session/subscriptions/{id}

HTTP Method: POST

Request Parameters: (expand)

Name Style Required Description

accept

Header

Restricted to:

  • application/json
  • application/xml

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.

container

Query

Specifies subscription scope to be a container rather than single entity

suppress_20x_code

Query

Restricted to:

  • false
  • true

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
400
Error processing "runas" value
400
Required header not specified
406
Unsupported value in Accept header
500
Internal error occurred

Subscribe Batch

Subscribes to notifications from one or more entities.

URI: /comb/v1/d/session/subscriptions/subscribe

HTTP Method: POST

Request Parameters: (expand)

Name Style Required Description

accept

Header

Restricted to:

  • application/json
  • application/xml

Directive to the server, indicating the format of the returned payload (or error class)

content-type

Header

Restricted to:

  • application/json
  • application/xml

The standard HTTP Content-Type Header, indicating the MIME type of the payload

runas

Query

Identity under-which to execute this operation. Callers require permission to run as a different identity.

container

Query

Specifies subscription scope to be a container rather than single entity

suppress_20x_code

Query

Restricted to:

  • false
  • true

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: beeIdList

Response Payload: No Response Payload

Fault: restFault

Details: (expand)

HTTP Status Description
400
Batch size exceeded
400
Error processing "runas" value
400
Format of ID specified is incorrect
400
Id type is incorrect
400
Invalid header specified
400
Invalid payload specified
400
JSON payload received with a wrong data member type
400
No payload specified
400
Required header not specified
400
Type of payload specified does not match what is expected
406
Unsupported value in Accept header
500
Internal error occurred

Unbsubscribe Batch

Unsubscribes from notifications from one or more entities.

URI: /comb/v1/d/session/subscriptions/unsubscribe

HTTP Method: POST

Request Parameters: (expand)

Name Style Required Description

accept

Header

Restricted to:

  • application/json
  • application/xml

Directive to the server, indicating the format of the returned payload (or error class)

content-type

Header

Restricted to:

  • application/json
  • application/xml

The standard HTTP Content-Type Header, indicating the MIME type of the payload

runas

Query

Identity under-which to execute this operation. Callers require permission to run as a different identity.

suppress_20x_code

Query

Restricted to:

  • false
  • true

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: beeIdList

Response Payload: No Response Payload

Fault: restFault

Details: (expand)

HTTP Status Description
400
Batch size exceeded
400
Error processing "runas" value
400
Format of ID specified is incorrect
400
Id type is incorrect
400
Invalid header specified
400
Invalid payload specified
400
JSON payload received with a wrong data member type
400
No payload specified
400
Required header not specified
400
Type of payload specified does not match what is expected
406
Unsupported value in Accept header
500
Internal error occurred

Unsubscribe

Unsubscribes from notifications from single entity.

URI: /comb/v1/d/session/subscriptions/{id}

HTTP Method: DELETE

Request Parameters: (expand)

Name Style Required Description

accept

Header

Restricted to:

  • application/json
  • application/xml

Directive to the server, indicating the format of the returned payload (or error class)

content-type

Header

Restricted to:

  • application/json
  • application/xml

The standard HTTP Content-Type Header, indicating the MIME type of the payload

runas

Query

Identity under-which to execute this operation. Callers require permission to run as a different identity.

suppress_20x_code

Query

Restricted to:

  • false
  • true

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
400
Error processing "runas" value
400
Required header not specified
406
Unsupported value in Accept header
500
Internal error occurred

Upload

Resource to accept uploads of arbitrary content. This operation only applies when working with Email, Wiki, or Documents. It is used to upload content to the server for later reference by an Email, Document, etc. Unlike other operations, there are no structured arguments. Payload can be simply uploaded as raw (binary) data, or using the format defined in RFC 1867.

URI: /comb/v1/d/session/upload

HTTP Method: POST

Request Parameters: (expand)

Name Style Required Description

uploadscope

Query

An arbitrary string that binds together multiple content that are uploaded for the same intent, such as multiple parts of an email message.

content_id

Query

Specifies an identifier for the uploaded content. If the uploaded content is the part of an email message, then this identifier is used to associate the content with the email message part

override_accept

Query

Restricted to:

  • application/json
  • application/xml

Use this parameter to override the Accept header sent in the request. This parameter is used only when uploading a file as content using a browser's form based file upload.

suppress_20x_code

Query

Restricted to:

  • false
  • true

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.

runas

Query

Identity under-which to execute this operation. Callers require permission to run as a different identity.

accept

Header

Restricted to:

  • application/json
  • application/xml

Directive to the server, indicating the format of the returned payload (or error class)

anticsrf

Query

Specifies the anti-CSRF token

Request Payload: No Request Payload

Response Payload: fileUploadSuccess

Fault: restFault

Details: (expand)

HTTP Status Description
400
Error occurred during upload
400
Error processing "runas" value
400
Invalid value specified for query parameter
400
No file uploaded
400
Required header not specified
400
Required query parameter not specified
406
Unsupported value in Accept header
500
Internal error occurred