SpiraPlan: REST Web Service (v5.0)

See all operations

GET: projects/{project_id}/data-mappings/{data_sync_system_id}/artifacts/{artifact_type_id}/custom-properties/{custom_property_id}


Retrieves the data mapping for a custom property

How to Execute

To access this REST web service, you need to use the following URL (make sure to replace any parameters (eg {project_id}) with the relevant value (eg 1):


Request Parameters

Name Description
project_id The id of the current project
data_sync_system_id The id of the plug-in
artifact_type_id The id of the type of artifact: (Requirement = 1, TestCase = 2, Incident = 3, Release = 4, TestRun = 5, Task = 6, TestStep = 7, TestSet = 8)
custom_property_id The id of the custom property

Request Body

Return Data

The JSON and XML examples below show the shape of one entry that will be returned. It does not show an example of how that entry will be populated.

Property Description
ProjectId The project that the data mapping entry relates to (null if it's not project specific)
InternalId The id of the item inside Spira
ExternalKey The id of the item in the external system
Primary Whether this is the primary external mapped value in the case of 1..n mapping