Meeting

Create

Create a new Meeting object.

URI: /comb/v1/d/invt

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
projection	Query	Restricted to: BASIC EMPTY FULL META	Level of detail of the meeting to return.
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
content-type	Header	Restricted to: application/json application/xml	The standard HTTP Content-Type Header, indicating the MIME type of the payload

Request Payload: meetingCreator

Response Payload: meeting

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Entity already exists
400	Error processing "runas" value
400	Invalid header specified
400	Invalid payload specified
400	Invalid value specified for query parameter
400	JSON payload received with a wrong data member type
400	No payload specified
400	Required header not specified
400	Required query parameter not specified
400	Type of payload specified does not match what is expected
406	Unsupported value in Accept header
500	Internal error occurred

Delete

Delete a Meeting

URI: /comb/v1/d/invt/{id}

HTTP Method: DELETE

Request Parameters: (expand)

Name	Style	Required	Description
snapshotid	Query
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: No Response Payload

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
400	Format of ID specified is incorrect
400	Id type is incorrect
400	Invalid value specified for query parameter
400	Required header not specified
400	Required query parameter not specified
406	Unsupported value in Accept header
500	Internal error occurred

Delete Batch

Delete one or more meetings

URI: /comb/v1/d/invt/delete

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
content-type	Header	Restricted to: application/json application/xml	The standard HTTP Content-Type Header, indicating the MIME type of the payload

Request Payload: beeIdList<meeting>

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	Invalid value specified for query parameter
400	JSON payload received with a wrong data member type
400	No payload specified
400	Required header not specified
400	Required query parameter not specified
400	Type of payload specified does not match what is expected
406	Unsupported value in Accept header
500	Internal error occurred

List Meetings In Range

List meetings based on the provided query. Note that the ParticipantUpdater and Calendar are both optional. If neither supplied, then the query will be based on the default calendar of the current user. The accepted types for participants are user resource and team workspace. When a participants is supplied then all the calendars associated with the participants will be searched. If both are supplied, the Calendar will be ignored and the query based only on the supplied user.

URI: /comb/v1/d/invt/list/byRange

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
projection	Query	Restricted to: BASIC EMPTY FULL META
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
content-type	Header	Restricted to: application/json application/xml	The standard HTTP Content-Type Header, indicating the MIME type of the payload

Request Payload: calendarRangeQuery

Response Payload: listResult<meeting>

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
400	Invalid header specified
400	Invalid payload specified
400	Invalid value specified for query parameter
400	JSON payload received with a wrong data member type
400	No payload specified
400	Required header not specified
400	Required query parameter not specified
400	Type of payload specified does not match what is expected
406	Unsupported value in Accept header
500	Internal error occurred

Read

Retreive a single Meeting.

URI: /comb/v1/d/invt/{id}

HTTP Method: GET

Request Parameters: (expand)

Name	Style	Required	Description
projection	Query	Restricted to: BASIC EMPTY FULL META	A projection specifying the details that should be returned in the meeting snapshot. null is not permitted
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.

Request Payload: No Request Payload

Response Payload: meeting

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
400	Format of ID specified is incorrect
400	Id type is incorrect
400	Invalid value specified for query parameter
400	Required header not specified
406	Unsupported value in Accept header
500	Internal error occurred

Read Attachment

Read the content of an attachment. Unlike many other access points in the API, the return is not structured data in XML/JSON, etc format. The returned payload is the streamed contents of a given attachment.

URI: /comb/v1/d/invt/attachment/{id}

HTTP Method: GET

Request Parameters: (expand)

Name	Style	Required	Description
streamid	Query		The content stream id of an attachment
preferred_content_type	Query		Use this parameter to specify a Content-Type header in the response headers. If unspecified, the default Content-Type of "application/octet-stream" is used.
preferred_filename	Query		Use this parameter to specify a filename in the Content-Disposition header in the response headers. If unspecified, then no Content-Disposition header is included in the response.
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.

Request Payload: No Request Payload

Response Payload: Raw Data

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
400	Format of ID specified is incorrect
400	Id type is incorrect
400	Invalid value specified for query parameter
400	Required header not specified
400	Required query parameter not specified
406	Unsupported value in Accept header
500	Internal error occurred

Read Batch

Retreives one or more Meeting objects from the server

URI: /comb/v1/d/invt/read

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
projection	Query	Restricted to: BASIC EMPTY FULL META	A projection specifying the details that should be returned in the meeting snapshots. null is not permitted
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
content-type	Header	Restricted to: application/json application/xml	The standard HTTP Content-Type Header, indicating the MIME type of the payload

Request Payload: beeIdList<meeting>

Response Payload: list<meeting>

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	Invalid value specified for query parameter
400	JSON payload received with a wrong data member type
400	No payload specified
400	Required header not specified
400	Required query parameter not specified
400	Type of payload specified does not match what is expected
406	Unsupported value in Accept header
500	Internal error occurred

Update

Update a single Meeting.

URI: /comb/v1/d/invt/{id}

HTTP Method: PUT

Request Parameters: (expand)

Name	Style	Required	Description
snapshotid	Query		Allow optimistic locking.
projection	Query	Restricted to: BASIC EMPTY FULL META	level of details to include in the returned snapshot.
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
content-type	Header	Restricted to: application/json application/xml	The standard HTTP Content-Type Header, indicating the MIME type of the payload

Request Payload: meetingUpdater

Response Payload: meeting

Fault: restFault

Details: (expand)

HTTP Status	Description
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	Invalid value specified for query parameter
400	JSON payload received with a wrong data member type
400	No payload specified
400	Required header not specified
400	Required query parameter not specified
400	Type of payload specified does not match what is expected
406	Unsupported value in Accept header
500	Internal error occurred