See all operations

PUT: data-mappings/{data_sync_system_id}/projects/{project_id}

Description

Updates the project data mapping for a specific data sync plugin. Only the ExternalKey is updated; the Active status is not modified.

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):

https://eti.spiraservice.net/Services/v7_0/RestService.svc/data-mappings/{data_sync_system_id}/projects/{project_id}

Request Parameters

Name	Description
data_sync_system_id	The id of the plug-in
project_id	The id of the project

Request Body

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
ArtifactTypeId	If the data mapping is an artifact data mapping, gives ArtifactTypeId whcih the InternalId relates to

<RemoteDataMapping xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
  <ArtifactTypeId i:nil="true" />
  <ExternalKey />
  <InternalId>-1</InternalId>
  <Primary>true</Primary>
  <ProjectId i:nil="true" />
</RemoteDataMapping>

{"ProjectId":null,
"InternalId":-1,
"ExternalKey":"",
"Primary":true,
"ArtifactTypeId":null}

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.

Nothing Returned

Nothing Returned