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 Work Items API

The Work Items API from Siemens PLM — 12 operation(s) for work items.

Siemens PLM Work Items 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 Work Items. 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 21 operations across 12 paths, and defines 22 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.

21 operations 12 paths 22 schemas 3 DELETE10 GET4 PATCH4 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 Work Items API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 21

Across 12 paths, the API surfaces 21 operations — 3 DELETE, 10 GET, 4 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Work Items 21
DELETE
/all/workitems
Deletes a list of Work Items from the Global context.
deleteAllWorkItems body → 2044004014034094134154XX-5XX
GET
/all/workitems
Returns a list of Work Items from all Projects.
getAllWorkItems 7 params → 2004004014034044064XX-5XX500
PATCH
/all/workitems
Updates a list of Work Items in the Global context.
patchAllWorkItems 1 param body → 2044004014034094134154XX-5XX
DELETE
/projects/{projectId}/workitems
Deletes a list of Work Items.
deleteWorkItems 1 param body → 204400401403404409413415
GET
/projects/{projectId}/workitems
Returns a list of Work Items.
getWorkItems 8 params → 2004004014034044064XX-5XX500
PATCH
/projects/{projectId}/workitems
Updates a list of Work Items.
patchWorkItems 3 params body → 204400401403404409413415
POST
/projects/{projectId}/workitems
Creates a list of Work Items.
postWorkItems 1 param body → 201400401403404406409413
GET
/projects/{projectId}/workitems/{workItemId}
Returns the specified Work Item.
getWorkItem 5 params → 2004004014034044064XX-5XX500
PATCH
/projects/{projectId}/workitems/{workItemId}
Updates the specified Work Item.
patchWorkItem 4 params body → 204400401403404409413415
GET
/projects/{projectId}/workitems/{workItemId}/actions/getWorkflowActions
Returns a list of Workflow Actions.
getWorkflowActionsForWorkItem 5 params → 2004004014034044064XX-5XX500
POST
/projects/{projectId}/workitems/{workItemId}/actions/moveFromDocument
Moves the specified Work Item from the Document.
moveFromDocument 2 params → 2044004014034044XX-5XX500503
POST
/projects/{projectId}/workitems/{workItemId}/actions/moveToDocument
Moves the specified Work Item to the Document.
moveToDocument 2 params body → 204400401403404409413415
GET
/projects/{projectId}/workitems/{workItemId}/fields/{fieldId}/actions/getAvailableOptions
Returns a list of available options for the requested field for the specified Work Item.
getAvailableEnumOptionsForWorkItem 5 params → 2004004014034044064XX-5XX500
GET
/projects/{projectId}/workitems/{workItemId}/fields/{fieldId}/actions/getCurrentOptions
Returns a list of selected options for the requested field for specific Work Item.
getCurrentEnumOptionsForWorkItem 6 params → 2004004014034044064XX-5XX500
DELETE
/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}
Deletes a list of Work Item Relationships.
deleteWorkItemsRelationship 3 params body → 204400401403404405409413
GET
/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}
Returns a list of Work Item Relationships.
getWorkItemsRelationships 8 params → 2004004014034044064XX-5XX500
PATCH
/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}
Updates a list of Work Item Relationships.
patchWorkItemRelationships 3 params body → 204400401403404409413415
POST
/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}
Creates a list of Work Item Relationships.
postWorkItemRelationships 3 params body → 204400401403404406413415
GET
/projects/{projectId}/workitems/{workItemId}/testparameterdefinitions
Returns a list of Test Parameter Definitions for the specified Work Item.
getWorkItemTestParameterDefinitions 7 params → 2004004014034044064XX-5XX500
GET
/projects/{projectId}/workitems/{workItemId}/testparameterdefinitions/{testParamId}
Returns the specified Test Parameter Definition for the specified Work Item.
getWorkItemTestParameterDefinition 6 params → 2004004014034044064XX-5XX500
GET
/projects/{projectId}/workitems/fields/{fieldId}/actions/getAvailableOptions
Returns a list of available options for the requested field for the specified Work Item Type.
getAvailableEnumOptionsForWorkItemType 5 params → 2004004014034044064XX-5XX500

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are sparseFields (45 properties), testparameter_definitionsListGetResponse (4 properties), workitemsListGetResponse (4 properties), workitemsSingleGetResponse (3 properties). Each schema is shown below with its type and property counts.

workitemsListDeleteRequest
object
1 property
sparseFields
object
45 properties
moveWorkItemToDocumentRequestBody
object
3 properties
workitemsSingleGetResponse
object
3 properties
enumOptionsActionResponseBody
object
3 properties
workitemsListPatchRequest
object
1 property
workitemsListPostRequest
object
1 property
RelationshipResponseBody
object
The Relationship's response body. Can return a single or a list of instances
RelationshipDataListRequest
object
1 property
RelationshipDataSingleResponse
object
1 property
RelationshipsRequestBody
object
List of generic contents
RelationshipDataSingleRequest
object
1 property
testparameter_definitionsListGetResponse
object
4 properties
workitemsListGetResponse
object
4 properties
relationshipsListDeleteRequest
object
1 property
errors
object
1 property
workflowActionsActionResponseBody
object
3 properties
workitemsListPostResponse
object
1 property
RelationshipDataListResponse
object
1 property
RelationshipDataBody
object
2 properties
testparameter_definitionsSingleGetResponse
object
3 properties
workitemsSinglePatchRequest
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

siemens-plm-work-items-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 Documents API
Where this information came from

This is an independent, third-party profile of Siemens PLM Work Items 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.