How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Siemens PLM Documents API

The Documents API from Siemens PLM — 12 operation(s) for documents.

Siemens PLM Documents API is one of 51 APIs that Siemens PLM publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, authentication docs, and a changelog.

This API exposes 14 operations across 12 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://example.com/polarion/rest/v1.

14 operations 12 paths 14 schemas 7 GET1 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://developer.siemens.com
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Siemens PLM Documents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 14

Across 12 paths, the API surfaces 14 operations — 7 GET, 1 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Documents 14
GET
/all/documents
Returns a list of Documents from all Projects.
getAllDocuments 7 params → 2004004014034044064XX-5XX500
POST
/all/documents/actions/branch
Creates Branches of Documents.
branchDocuments body → 2024004014064134154XX-5XX500
GET
/projects/{projectId}/documents
Returns a list of Documents from the Project context.
getDocuments 8 params → 2004004014034044064XX-5XX500
GET
/projects/{projectId}/documents/fields/{fieldId}/actions/getAvailableOptions
Returns a list of available options for the requested field for the specified Document type.
getAvailableEnumOptionsForDocumentType 5 params → 2004004014034044064XX-5XX500
GET
/projects/{projectId}/spaces/{spaceId}/documents
Returns a list of Documents from a given Project Space.
getSpaceDocuments 8 params → 2004004014034044064XX-5XX500
POST
/projects/{projectId}/spaces/{spaceId}/documents
Creates a list of Documents.
postDocuments 2 params body → 201400401403404406409413
GET
/projects/{projectId}/spaces/{spaceId}/documents/{documentName}
Returns the specified Document.
getDocument 6 params → 2004004014034044064XX-5XX500
PATCH
/projects/{projectId}/spaces/{spaceId}/documents/{documentName}
Updates the specified Document.
patchDocument 4 params body → 204400401403404409413415
POST
/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/branch
Creates a Branch of the Document.
branchDocument 4 params body → 201400401403404406409413
POST
/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/copy
Creates a copy of the Document.
copyDocument 4 params body → 201400401403404406409413
POST
/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/mergeFromMaster
Merges Master Work Item changes to the specified Branched Document.
mergeDocumentFromMaster 3 params body → 202400401403404406409413
POST
/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/mergeToMaster
Merges Work Item changes from specified Branched Document to Master.
mergeDocumentToMaster 3 params body → 202400401403404406409413
GET
/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/fields/{fieldId}/actions/getAvailableOptions
Returns a list of available options for the requested field in the specified Document.
getAvailableEnumOptionsForDocument 6 params → 2004004014034044064XX-5XX500
GET
/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/fields/{fieldId}/actions/getCurrentOptions
Returns a list of selected options for the requested field in the specified Document.
getCurrentEnumerationOptionsForDocument 7 params → 2004004014034044064XX-5XX500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are sparseFields (45 properties), copyDocumentRequestBody (5 properties), branchDocumentRequestBody (5 properties), documentsListGetResponse (4 properties). Each schema is shown below with its type and property counts.

documentsListGetResponse
object
4 properties
copyDocumentRequestBody
object
5 properties
documentsSinglePatchRequest
object
1 property
documentsListPostRequest
object
1 property
enumOptionsActionResponseBody
object
3 properties
branchDocumentsRequestBody
object
1 property 1 required
documentsSingleGetResponse
object
3 properties
branchDocumentRequestBody
object
5 properties
sparseFields
object
45 properties
mergeDocumentRequestBody
object
2 properties
documentsSinglePostResponse
object
1 property
errors
object
1 property
documentsListPostResponse
object
1 property
jobsSinglePostResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

siemens-plm-documents-api-openapi.yml Raw ↑

Other APIs Siemens PLM publishes across the network.

Insights Hub and Industrial IoT APIs
SiGREEN API
Siemens PLM Account API
Siemens PLM Administration API
Siemens PLM Basic API
Siemens PLM Collections API
Siemens PLM Custom Fields API
Siemens PLM Customer Information: API Key API
Siemens PLM Document Attachments API
Siemens PLM Document Comments API
Siemens PLM Document Parts API
Siemens PLM Enumerations API
Where this information came from

This is an independent, third-party profile of Siemens PLM Documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.