Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ExportNotebook

Exports the specified notebook and its metadata.

Request Syntax


{
   "NotebookId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

NotebookId

The ID of the notebook to export.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: Yes

Response Syntax


{
   "NotebookMetadata": { 
      "CreationTime": number,
      "LastModifiedTime": number,
      "Name": "string",
      "NotebookId": "string",
      "Type": "string",
      "WorkGroup": "string"
   },
   "Payload": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NotebookMetadata

The notebook metadata, including notebook ID, notebook name, and workgroup name.

Type: NotebookMetadata object

Payload

The content of the exported notebook.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 10485760.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

Indicates a platform issue, which may be due to a transient condition or outage.

HTTP Status Code: 500

InvalidRequestException

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

HTTP Status Code: 400

TooManyRequestsException

Indicates that the request was throttled.

HTTP Status Code: 400