Capmo Docs

Where To Start
Errors
File Management API

Capmo REST API

Organisation People
Organisation Companies
Organisation Memberships
Project Templates
- /api/v1/project-templatesget
- /api/v1/project-templates/{projectTemplateId}get
Projects
Project People
Project Companies
Project Memberships
Project Documents
Project Plans
Project Tickets
Project Ticket Categories
- /api/v1/projects/{projectId}/ticket-categoriesget
Project Ticket Types
- /api/v1/projects/{projectId}/ticket-typesget
Project Ticket Tags
- /api/v1/projects/{projectId}/ticket-tagsget
Project Ticket Comments
- /api/v1/projects/{projectId}/tickets/{ticketId}/commentsget
Project Ticket Attachments
Project Site Journals
Uploads
Other
- /api/v1/validateget

Capmo Docs

Where To Start
Errors
File Management API

Capmo REST API

Organisation People
Organisation Companies
Organisation Memberships
Project Templates
- /api/v1/project-templatesget
- /api/v1/project-templates/{projectTemplateId}get
Projects
Project People
Project Companies
Project Memberships
Project Documents
Project Plans
Project Tickets
Project Ticket Categories
- /api/v1/projects/{projectId}/ticket-categoriesget
Project Ticket Types
- /api/v1/projects/{projectId}/ticket-typesget
Project Ticket Tags
- /api/v1/projects/{projectId}/ticket-tagsget
Project Ticket Comments
- /api/v1/projects/{projectId}/tickets/{ticketId}/commentsget
Project Ticket Attachments
Project Site Journals
Uploads
Other
- /api/v1/validateget

/api/v1/projects/{projectId}/plans/{planId}

get https://api.capmo.de/api/v1/projects/{projectId}/plans/{planId}

This can be used to get a single project plan.

Path Params

projectId

string

required

planId

string

required

Headers

Request-Id

json

The HTTP Request-Id request header is an optional and unofficial HTTP header, used to trace individual HTTP requests from the client to the server and back again. It allows the client and server to correlate each HTTP request. If not provided by the client, the server should generate a unique request ID and include it in the response.

Responses

Response body

object

message

string

data

object

source_id

string

The unique identifier of the source. This is a user-generated string. You can use this to link the person to a resource in an external system.

created_by

string | null

required

The unique identifier of the creator of the entity.

updated_by

string | null

required

The unique identifier of the last user who updated the entity.

created_at

date-time

required

The date when the entity was created (on the client).

updated_at

date-time

required

The date when the entity was last updated (on the client).

deleted_at

date-time | null

required

The date when the entity was deleted (on the client).

server_created_at

date-time

required

The date when the entity was created (on the server).

server_updated_at

date-time

required

The date when the entity was last updated (on the server).

server_deleted_at

date-time | null

required

The date when the entity was deleted (on the server).

string

required

Unique ID of the plan.

name

string

required

The name of the plan.

description

string | null

required

The description of the plan.

folder_id

string | null

required

ID of the folder containing the plan. If set to null, refers to the default "Unsorted" folder.

file_id

string

required

ID of the plan file attached to this plan.

file_name

string | null

required

The name of the plan file attached to this plan, including its extension.

status

string | null

required

Plan rendering status.

pending processing completed failed

file_source_type

string | null

required

Type of the plan source.

LOCAL CDE

file_source_id

string | null

required

ID of the document. Only set if source_type is CDE.

has_new_source_version_available

boolean | null

required

True when the document has a new version available. Only set if source_type is CDE.

total_versions

number

required

Number of versions available for this plan.

version_number

number

required

Latest version number available for this plan.

image_url

string | null

required

The URL of the plan file preview in PNG format.

signed_url

string | null

required

The URL to download the plan file.

Response body

object

type

string

message

string

errors

array of objects

errors

object

code

string

message

string

Response body

object

type

string

message

string

errors

array of objects

errors

object

code

string

message

string

Response body

object

type

string

message

string

errors

array of objects

errors

object

code

string

message

string

Response body

object

type

string

message

string

errors

array of objects

errors

object

code

string

message

string

Response body

object

type

string

message

string

errors

array of objects

errors

object

code

string

message

string

Response body

object

type

string

message

string

errors

array of objects

errors

object

code

string

message

string

Updated 11 months ago

/api/v1/projects/{projectId}/plans

/api/v1/projects/{projectId}/plans/{planId}

Did this page help you?

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.capmo.de/api/v1/projects/projectId/plans/planId \
3
     --header 'Request-Id: YOUR_REQUEST_ID' \
4
     --header 'accept: application/json'

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

application/json

Updated 11 months ago

/api/v1/projects/{projectId}/plans

/api/v1/projects/{projectId}/plans/{planId}

Did this page help you?

Capmo Docs
Where To Start
Errors
File Management API

Capmo REST API
Organisation People
/api/v1/organisation/people/{personId}delete
/api/v1/organisation/people/{personId}patch
/api/v1/organisation/people/{personId}get
/api/v1/organisation/peoplepost
/api/v1/organisation/peopleget
Organisation Companies
/api/v1/organisation/companies/{companyId}delete
/api/v1/organisation/companies/{companyId}patch
/api/v1/organisation/companies/{companyId}get
/api/v1/organisation/companiespost
/api/v1/organisation/companiesget
Organisation Memberships
/api/v1/organisation/memberships/{membershipId}delete
/api/v1/organisation/memberships/{membershipId}patch
/api/v1/organisation/memberships/{membershipId}get
/api/v1/organisation/membershipspost
/api/v1/organisation/membershipsget
Project Templates
/api/v1/project-templates/{projectTemplateId}get
/api/v1/project-templatesget
Projects
/api/v1/projects/{projectId}delete
/api/v1/projects/{projectId}patch
/api/v1/projects/{projectId}get
/api/v1/projectspost
/api/v1/projectsget
Project People
/api/v1/projects/{projectId}/people-from-organisationpost
/api/v1/projects/{projectId}/people/{personId}delete
/api/v1/projects/{projectId}/people/{personId}patch
/api/v1/projects/{projectId}/people/{personId}get
/api/v1/projects/{projectId}/peoplepost
/api/v1/projects/{projectId}/peopleget
Project Companies
/api/v1/projects/{projectId}/companies-from-organisationpost
/api/v1/projects/{projectId}/companies/{companyId}delete
/api/v1/projects/{projectId}/companies/{companyId}patch
/api/v1/projects/{projectId}/companies/{companyId}get
/api/v1/projects/{projectId}/companiespost
/api/v1/projects/{projectId}/companiesget
Project Memberships
/api/v1/projects/{projectId}/memberships/{membershipId}delete
/api/v1/projects/{projectId}/memberships/{membershipId}get
/api/v1/projects/{projectId}/membershipspost
/api/v1/projects/{projectId}/membershipsget
Project Documents
/api/v1/projects/{projectId}/document-folders/{folderId}delete
/api/v1/projects/{projectId}/document-folders/{folderId}patch
/api/v1/projects/{projectId}/document-folders/{folderId}get
/api/v1/projects/{projectId}/document-folderspost
/api/v1/projects/{projectId}/document-foldersget
/api/v1/projects/{projectId}/document-files/{fileId}delete
/api/v1/projects/{projectId}/document-files/{fileId}patch
/api/v1/projects/{projectId}/document-files/{fileId}get
/api/v1/projects/{projectId}/document-filesget
/api/v1/projects/{projectId}/document-filespost
Project Plans
/api/v1/projects/{projectId}/plans/{planId}patch
/api/v1/projects/{projectId}/plans/{planId}delete
/api/v1/projects/{projectId}/plans/{planId}get
/api/v1/projects/{projectId}/plansget
/api/v1/projects/{projectId}/planspost
/api/v1/projects/{projectId}/plan-folders/{folderId}delete
/api/v1/projects/{projectId}/plan-folders/{folderId}patch
/api/v1/projects/{projectId}/plan-folderspost
/api/v1/projects/{projectId}/plan-foldersget
Project Tickets
/api/v1/projects/{projectId}/tickets/{ticketId}delete
/api/v1/projects/{projectId}/tickets/{ticketId}patch
/api/v1/projects/{projectId}/tickets/{ticketId}get
/api/v1/projects/{projectId}/ticketspost
/api/v1/projects/{projectId}/ticketsget
Project Ticket Categories
/api/v1/projects/{projectId}/ticket-categoriesget
Project Ticket Types
/api/v1/projects/{projectId}/ticket-typesget
Project Ticket Tags
/api/v1/projects/{projectId}/ticket-tagsget
Project Ticket Comments
/api/v1/projects/{projectId}/tickets/{ticketId}/commentsget
Project Ticket Attachments
/api/v1/projects/{projectId}/tickets/{ticketId}/attachments/{attachmentId}delete
/api/v1/projects/{projectId}/tickets/{ticketId}/attachments/{attachmentId}get
/api/v1/projects/{projectId}/tickets/{ticketId}/attachmentspost
/api/v1/projects/{projectId}/tickets/{ticketId}/attachmentsget
Project Site Journals
/api/v1/projects/{projectId}/site-journals/{siteJournalId}delete
/api/v1/projects/{projectId}/site-journals/{siteJournalId}patch
/api/v1/projects/{projectId}/site-journals/{siteJournalId}get
/api/v1/projects/{projectId}/site-journalspost
/api/v1/projects/{projectId}/site-journalsget
Uploads
/api/v1/upload/ticket-attachmentspost
/api/v1/upload/planspost
/api/v1/upload/projects/{projectId}/document-filespost
Other
/api/v1/validateget

Capmo Docs
Where To Start
Errors
File Management API

Capmo REST API
Organisation People
/api/v1/organisation/people/{personId}delete
/api/v1/organisation/people/{personId}patch
/api/v1/organisation/people/{personId}get
/api/v1/organisation/peoplepost
/api/v1/organisation/peopleget
Organisation Companies
/api/v1/organisation/companies/{companyId}delete
/api/v1/organisation/companies/{companyId}patch
/api/v1/organisation/companies/{companyId}get
/api/v1/organisation/companiespost
/api/v1/organisation/companiesget
Organisation Memberships
/api/v1/organisation/memberships/{membershipId}delete
/api/v1/organisation/memberships/{membershipId}patch
/api/v1/organisation/memberships/{membershipId}get
/api/v1/organisation/membershipspost
/api/v1/organisation/membershipsget
Project Templates
/api/v1/project-templates/{projectTemplateId}get
/api/v1/project-templatesget
Projects
/api/v1/projects/{projectId}delete
/api/v1/projects/{projectId}patch
/api/v1/projects/{projectId}get
/api/v1/projectspost
/api/v1/projectsget
Project People
/api/v1/projects/{projectId}/people-from-organisationpost
/api/v1/projects/{projectId}/people/{personId}delete
/api/v1/projects/{projectId}/people/{personId}patch
/api/v1/projects/{projectId}/people/{personId}get
/api/v1/projects/{projectId}/peoplepost
/api/v1/projects/{projectId}/peopleget
Project Companies
/api/v1/projects/{projectId}/companies-from-organisationpost
/api/v1/projects/{projectId}/companies/{companyId}delete
/api/v1/projects/{projectId}/companies/{companyId}patch
/api/v1/projects/{projectId}/companies/{companyId}get
/api/v1/projects/{projectId}/companiespost
/api/v1/projects/{projectId}/companiesget
Project Memberships
/api/v1/projects/{projectId}/memberships/{membershipId}delete
/api/v1/projects/{projectId}/memberships/{membershipId}get
/api/v1/projects/{projectId}/membershipspost
/api/v1/projects/{projectId}/membershipsget
Project Documents
/api/v1/projects/{projectId}/document-folders/{folderId}delete
/api/v1/projects/{projectId}/document-folders/{folderId}patch
/api/v1/projects/{projectId}/document-folders/{folderId}get
/api/v1/projects/{projectId}/document-folderspost
/api/v1/projects/{projectId}/document-foldersget
/api/v1/projects/{projectId}/document-files/{fileId}delete
/api/v1/projects/{projectId}/document-files/{fileId}patch
/api/v1/projects/{projectId}/document-files/{fileId}get
/api/v1/projects/{projectId}/document-filesget
/api/v1/projects/{projectId}/document-filespost
Project Plans
/api/v1/projects/{projectId}/plans/{planId}patch
/api/v1/projects/{projectId}/plans/{planId}delete
/api/v1/projects/{projectId}/plans/{planId}get
/api/v1/projects/{projectId}/plansget
/api/v1/projects/{projectId}/planspost
/api/v1/projects/{projectId}/plan-folders/{folderId}delete
/api/v1/projects/{projectId}/plan-folders/{folderId}patch
/api/v1/projects/{projectId}/plan-folderspost
/api/v1/projects/{projectId}/plan-foldersget
Project Tickets
/api/v1/projects/{projectId}/tickets/{ticketId}delete
/api/v1/projects/{projectId}/tickets/{ticketId}patch
/api/v1/projects/{projectId}/tickets/{ticketId}get
/api/v1/projects/{projectId}/ticketspost
/api/v1/projects/{projectId}/ticketsget
Project Ticket Categories
/api/v1/projects/{projectId}/ticket-categoriesget
Project Ticket Types
/api/v1/projects/{projectId}/ticket-typesget
Project Ticket Tags
/api/v1/projects/{projectId}/ticket-tagsget
Project Ticket Comments
/api/v1/projects/{projectId}/tickets/{ticketId}/commentsget
Project Ticket Attachments
/api/v1/projects/{projectId}/tickets/{ticketId}/attachments/{attachmentId}delete
/api/v1/projects/{projectId}/tickets/{ticketId}/attachments/{attachmentId}get
/api/v1/projects/{projectId}/tickets/{ticketId}/attachmentspost
/api/v1/projects/{projectId}/tickets/{ticketId}/attachmentsget
Project Site Journals
/api/v1/projects/{projectId}/site-journals/{siteJournalId}delete
/api/v1/projects/{projectId}/site-journals/{siteJournalId}patch
/api/v1/projects/{projectId}/site-journals/{siteJournalId}get
/api/v1/projects/{projectId}/site-journalspost
/api/v1/projects/{projectId}/site-journalsget
Uploads
/api/v1/upload/ticket-attachmentspost
/api/v1/upload/planspost
/api/v1/upload/projects/{projectId}/document-filespost
Other
/api/v1/validateget

200The project plan has been successfully retrieved.

400Bad request, Invalid input

401Unauthorized

403Forbidden

404Object not found

409Conflict

500Internal server error