Rocketlane API

Tasks
Fields
Projects
Resource Allocations
- Get all Resource allocationsget
Phases
Time-Offs
Users
- Get user by Idget
- Get all usersget
Spaces
Time Tracking
Space Documents

Rocketlane API

Tasks
Fields
Projects
Resource Allocations
- Get all Resource allocationsget
Phases
Time-Offs
Users
- Get user by Idget
- Get all usersget
Spaces
Time Tracking
Space Documents

Create a space document

post https://api.rocketlane.com/api/1.0/space-documents

URL Expired

The URL for this request expired after 30 days.

The Create a space document API allows users to create a new space document in the system for the given project. This endpoint provides a way for developers to add space document related details, including the spaceDocumentName, spaceDocumentType, url and source fields for the space object. This API returns the created space document object.

In case any issues arise or further assistance is required, please refer to the error handling section or reach out to our support team at care@rocketlane.com for a prompt resolution.

Body Params

spaceDocumentName

string

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

space

object

required

Information about the space to which the space document belongs to.

spaceDocumentType

string

required

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

url

string

The url that is embedded in the space document.

source

object

Sources denote the document templates based on which the document is created

Responses

Response body

object

spaceDocumentId

int64

≥ 1

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

spaceDocumentName

string

Defaults to Untitled

The name of the space document.

space

object

Information about the space to which the space document belongs to.

spaceId

int64

≥ 1

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

spaceName

string

The name of the space.

spaceDocumentType

string

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

ROCKETLANE_DOCUMENT EMBEDDED_DOCUMENT

url

string

The url that is embedded in the space document.

source

object

Sources denote the document templates based on which the document is created

templateId

int64

The unique identifier for the template.

templateName

string

The name of the template.

createdAt

int64

The timestamp when the space document was created.

createdBy

object

The team member who created the space document.

emailId

string

The team members email identifier.

userId

int64

The unique identifier for the user.

firstName

string

The first name of the user.

lastName

string

The last name of the user.

updatedAt

int64

The timestamp when the space document was last updated.

updatedBy

object

The team member who updated the space document.

emailId

string

The team members email identifier.

userId

int64

The unique identifier for the user.

firstName

string

The first name of the user.

lastName

string

The last name of the user.

private

boolean

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

Response body

object

errors

array of objects

errors

object

errorCode

string

Error code refers to the type of error that you are facing. Some examples of error codes are: BAD_REQUEST, NOT_FOUND, INTERNAL_SERVER_ERROR.

errorMessage

string

Error message describes in brief about the issue. You can read the error message to get a understanding of where the request went wrong and attempt to fix it.

field

string

Fields refers to the parameter/field that was invalid in the request (if any). It will point you to the field that needs attention.

Response body

object

errors

array of objects

errors

object

errorCode

string

Error code refers to the type of error that you are facing. Some examples of error codes are: BAD_REQUEST, NOT_FOUND, INTERNAL_SERVER_ERROR.

errorMessage

string

Error message describes in brief about the issue. You can read the error message to get a understanding of where the request went wrong and attempt to fix it.

Updated 10 months ago

Get all space documents

Did this page help you?

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.rocketlane.com/api/1.0/space-documents \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "spaceDocumentType": "ROCKETLANE_DOCUMENT"
8
}
9
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 10 months ago

Get all space documents

Did this page help you?

Rocketlane API
Tasks
Create a taskpost
Get all tasksget
Add assignees to a task by Idpost
Add dependencies to a task by Idpost
Add followers to a task by Idpost
Move a task to the phase by Idpost
Remove assignees from a task by Idpost
Remove dependencies from a task by Idpost
Remove followers from a task by Idpost
Delete task by Iddelete
Update task by Idput
Get task by Idget
Fields
Create a Fieldpost
Get all fieldsget
Add field Optionpost
Update field Optionpost
Delete field by Iddelete
Update field by Idput
Get field by Idget
Projects
Create a projectpost
Get all projectsget
Add members to a projectpost
Archive project by Idpost
Assign placeholders to an user in a projectpost
Import a template to a projectpost
Remove members from a projectpost
Un assign placeholders from an user in a projectpost
Delete project by Iddelete
Update project by Idput
Get project by Idget
Resource Allocations
Get all Resource allocationsget
Phases
Create a phasepost
Get all phasesget
Delete phase by Iddelete
Update phase by Idput
Get phase by Idget
Time-Offs
Delete a time-offdelete
Get time-off by Idget
Create a time-offpost
Get all time-offsget
Users
Get all usersget
Get user by Idget
Spaces
Create a spacepost
Get all spacesget
Delete space by Iddelete
Update space by Idput
Get space by Idget
Time Tracking
Get time entry categoriesget
Search time entriesget
Create a time entrypost
Get all time entriesget
Delete a time entrydelete
Update a time entryput
Get a time entryget
Space Documents
Create a space documentpost
Get all space documentsget
Delete space document by Iddelete
Update space document by Idput
Get space document by Idget

Rocketlane API
Tasks
Create a taskpost
Get all tasksget
Add assignees to a task by Idpost
Add dependencies to a task by Idpost
Add followers to a task by Idpost
Move a task to the phase by Idpost
Remove assignees from a task by Idpost
Remove dependencies from a task by Idpost
Remove followers from a task by Idpost
Delete task by Iddelete
Update task by Idput
Get task by Idget
Fields
Create a Fieldpost
Get all fieldsget
Add field Optionpost
Update field Optionpost
Delete field by Iddelete
Update field by Idput
Get field by Idget
Projects
Create a projectpost
Get all projectsget
Add members to a projectpost
Archive project by Idpost
Assign placeholders to an user in a projectpost
Import a template to a projectpost
Remove members from a projectpost
Un assign placeholders from an user in a projectpost
Delete project by Iddelete
Update project by Idput
Get project by Idget
Resource Allocations
Get all Resource allocationsget
Phases
Create a phasepost
Get all phasesget
Delete phase by Iddelete
Update phase by Idput
Get phase by Idget
Time-Offs
Delete a time-offdelete
Get time-off by Idget
Create a time-offpost
Get all time-offsget
Users
Get all usersget
Get user by Idget
Spaces
Create a spacepost
Get all spacesget
Delete space by Iddelete
Update space by Idput
Get space by Idget
Time Tracking
Get time entry categoriesget
Search time entriesget
Create a time entrypost
Get all time entriesget
Delete a time entrydelete
Update a time entryput
Get a time entryget
Space Documents
Create a space documentpost
Get all space documentsget
Delete space document by Iddelete
Update space document by Idput
Get space document by Idget

201The resource was successfully created in the database.

400This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.

401You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.