Sign in

v1

latestOpenAPI 3.0.12026-07-2464217456.8 KB
Space Documents

Create a space document

post/1.0/space-documents

Request body

spaceDocumentIdinteger

The space document's unique, system-generated identifier, which can be used to identify the space document globally.

spaceDocumentNamestring

The name of the space document.By default, the name is 'Untitled'.

spaceDocumentType'ROCKETLANE_DOCUMENT' | 'EMBEDDED_DOCUMENT' required

Defines the type of the space document. This could be a Rocketlane document or an embedded document.

urlstring

The url that is embedded in the space document.

Example request

{
  "spaceDocumentId": 201,
  "spaceDocumentName": "Sample file",
  "space": {
    "spaceId": 201,
    "spaceName": "General space"
  },
  "spaceDocumentType": "ROCKETLANE_DOCUMENT",
  "url": "https://www.google.com",
  "source": {
    "templateId": 201,
    "templateName": "Meeting Notes"
  }
}

Response

The resource was successfully created in the database.

spaceDocumentIdinteger

The space document's unique, system-generated identifier, which can be used to identify the space document globally.

spaceDocumentNamestring

The name of the space document.

spaceDocumentType'ROCKETLANE_DOCUMENT' | 'EMBEDDED_DOCUMENT'

Defines the type of the space document. This could be a Rocketlane document or an embedded document.

urlstring

The url that is embedded in the space document.

createdAtinteger

The timestamp when the space document was created.

updatedAtinteger

The timestamp when the space document was last updated.

privateboolean

Describes the privacy of the space i.e. if it is private or shared.

Example response

{
  "spaceDocumentId": 201,
  "spaceDocumentName": "Sample file",
  "space": {
    "spaceId": 201,
    "spaceName": "General space"
  },
  "spaceDocumentType": "ROCKETLANE_DOCUMENT",
  "url": "https://www.google.com",
  "source": {
    "templateId": 201,
    "templateName": "Meeting Notes"
  },
  "createdAt": 1680616174929,
  "createdBy": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "updatedAt": 1680616174929,
  "updatedBy": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "private": true
}