You are not logged in. Click here
to log in.
codebeamer Application Lifecycle Management (ALM)
Codebeamer DOORS Bridge REST APITable of Contents
Codebeamer 9.1 and newer, also has special DOORS Bridge
This document only describes the DOORS Bridge specific functionality. Please see
Get the Top-Level Nodes of the DOORS HierarchyGET /doors/hierarchy[?options]
The response contains an array of JSON objects, where each object represents an item in the DOORS hierarchy.
The "type" of an item is:
E.g. GET /doors/hierarchy?server=http://my-doors-bridge:9090/db&username=...&password=... [ {
"id" : "00000001",
"type" : 2,
"name" : "Klaus Test",
"description" : "Testprojekt für Tests von Klaus"
}, {
"id" : "00000002",
"type" : 1,
"name" : "Intland Software",
"description" : "Daten von Intland Software"
}, {
"id" : "00000003",
"type" : 1,
"name" : "Mechatronics",
"description" : "Merit Automotive Electronics"
}, {
"id" : "00000004",
"type" : 2,
"name" : "Test Project"
}, {
"id" : "00000005",
"type" : 2,
"name" : "ReqIF Test",
"description" : "Project to test ReqIF import/export"
} ]
Get the Children or Descendants of the Specified DOORS Hierarchy NodeGET /doors/{node}/children[?options]
The response contains an array of JSON objects, where each object represents an item in the DOORS hierarchy. E.g. GET /doors/00000001/children?server=http://my-doors-bridge:9090/db&username=...&password=...&recursively=true [ {
"id" : "00000020",
"type" : 3,
"name" : "Pflichtenheft",
"description" : "Ein Test Pflichenheft"
}, {
"id" : "00000021",
"type" : 1,
"name" : "Testmanagement",
"description" : "Daten für das Testmanagement",
"children" : [ {
"id" : "00000040",
"type" : 1,
"name" : "Spezifikationen",
"description" : "Testfälle und Testspezifikationen",
"children" : [ {
"id" : "00000060",
"type" : 3,
"name" : "Testfälle",
"description" : "Testfall Spezifiationen"
} ]
}, {
"id" : "00000041",
"type" : 1,
"name" : "Testprotokolle",
"description" : "Protokolle/Ergebnisse"
} ]
} ]
Get the Baseline Sets Defined in the Specified DOORS Project or FolderGET /doors/{projectOrFolder}/baselineSets[?options]
The response contains an array of JSON objects, where each object represents a DOORS baseline set definition, including modules and baseline sets.
E.g. GET /doors/000000a0/baselineSet?server=http://my-doors-bridge:9090/db&username=...&password=...&baselines=true [ {
"name" : "SA deliveries",
"description" : "Baselines made after each SA docs delivery",
"modules" : [ {
"id" : "00000182",
"name" : "RTD_10024803_I",
"description" : "RTD - B3",
"path" : "/Mechatronics/10024803/02_SYS_REQs/RTD_10024803_I"
}, {
"id" : "00000260",
"name" : "EETP_10024803",
"description" : "Electrical Test Specification",
"path" : "/Mechatronics/10024803/10_SYS_Test/EE/EETP_10024803"
}, {
...
} ],
"baselineSets" : [ {
"id" : "1.0.1.0",
"description" : "SA B1 delivery",
"Created On" : 1394625274,
"Created By" : "krzysztof",
"baselines" : {
"00000182" : "3.0.1.0",
"00000260" : "3.0.1.0",
...
}
}, {
...
} ]
}, {
...
} ]
Get the Metadata (Attributes and Link Types) of the Specified DOORS ModuleGET /doors/{module}/metaData[?options]
The response is a JSON object with the attributes and link types of the specified module.
The "type" of an attribute is:
E.g. GET /doors/00000020/metaData?server=http://my-doors-bridge:9090/db&username=...&password=...
{
"id" : "00000020",
"name" : "Pflichtenheft",
"description" : "Ein Test Pflichenheft",
"locked" : true,
"attributes" : [ {
"name" : "Created By",
"type" : 5,
"memberType" : 2
}, {
"name" : "Created On",
"type" : 3
}, {
"name" : "Created Thru",
"type" : 6,
"options" : [ {
"id" : 0,
"name" : "Manual Input"
}, {
"id" : 1,
"name" : "Extracting"
}, {
"id" : 2,
"name" : "Copying"
} ],
"default" : "Manual Input"
}, {
"name" : "Last Modified By",
"type" : 5,
"memberType" : 2
}, {
"name" : "Last Modified On",
"type" : 3
}, {
"name" : "Priorität",
"description" : "Die Priorität der Anforderung",
"type" : 6,
"options" : [ {
"id" : 1,
"name" : "Nice to have",
"color" : 0
}, {
"id" : 2,
"name" : "Want to have",
"color" : 33
}, {
"id" : 3,
"name" : "Must have",
"color" : 29
} ],
"editable" : true
}, {
"name" : "Speisefolge",
"description" : "Umfang des gewünschten Menüs",
"type" : 6,
"options" : [ {
"id" : 1,
"name" : "Vorspeise"
}, {
"id" : 2,
"name" : "Suppe"
}, {
"id" : 3,
"name" : "Hauptgericht"
}, {
"id" : 4,
"name" : "Dessert"
} ],
"multiple" : true,
"editable" : true
}, {
"name" : "Status",
"description" : "Der Status der Anforderung",
"type" : 6,
"options" : [ {
"id" : 1,
"name" : "Entwurf",
"color" : 28
}, {
"id" : 3,
"name" : "Akzeptiert",
"color" : 25
}, {
"id" : 2,
"name" : "Abgelehnt",
"color" : 13
} ],
"editable" : true
}, {
"name" : "attachments",
"type" : 7,
"refType" : 5,
"refQuali" : [ "attachment" ],
"multiple" : true,
"label" : "Attachments",
"description" : "Whether to import embedded OLE objects and pictures as attachments, or only the object rich text without embedded OLE objects and pictures",
"editable" : true
}, {
"name" : "discussions",
"type" : 7,
"refType" : 5,
"refQuali" : [ "comment" ],
"multiple" : true,
"label" : "Discussions",
"description" : "Whether to also import object discussions and comments, or not. (Only possible, if users are also imported)",
"editable" : true
}, {
"name" : "history",
"type" : 7,
"refType" : 5,
"refQuali" : [ "change" ],
"multiple" : true,
"label" : "History",
"description" : "Whether to also import the object history, or not. (Only possible, if users are also imported)"
} ],
"linkTypes" : [ {
"id" : "00000022",
"name" : "DOORS Links",
"description" : "Automatisch von DOORS erstelltes Linkmodul",
"attributes" : [ {
"name" : "Created By",
"type" : 5,
"memberType" : 2
}, {
"name" : "Created On",
"type" : 3
}, {
"name" : "Last Modified By",
"type" : 5,
"memberType" : 2
}, {
"name" : "Last Modified On",
"type" : 3
} ]
}, {
"id" : "External",
"name" : "External",
"description" : "Links to external resources",
"attributes" : [ {
"name" : "Created By",
"type" : 5,
"memberType" : 2
}, {
"name" : "Created On",
"type" : 3
}, {
"name" : "Last Modified By",
"type" : 5,
"memberType" : 2
}, {
"name" : "Last Modified On",
"type" : 3
} ]
} ]
}
For more details, see section You must login to see this link. Register now, if you have no user account yet..
Get a HTML Preview of the Specified DOORS ModuleGET /doors/{module}/preview[?options]
The response is an HTML fragment in UTF-8 encoding.
E.g. GET /doors/00000020/preview?server=http://my-doors-bridge:9090/db&username=...&password=...
Get Information about All Registered DOORS BridgesSince Codebeamer release 22.10-LTS (GINA).GET / doors/bridges
You only get information about DOORS Bridges that are either public, or where you have explicit access. For example: [ {
"id" : 12345,
"server" : "http://my-doors-bridge:9090/db",
"description" : "DOORS 9.7 Bridge",
"public" : true
} ]
Get Information about a Specific DOORS BridgeSince Codebeamer release 22.10-LTS (GINA).GET /doors/bridge/{bridgeId}
You only get information about DOORS Bridges that are either public, or where you have explicit access. For example: GET /doors/bridge/12345
{
"id" : 12345,
"server" : "http://my-doors-bridge:9090/db",
"description" : "DOORS 9.7 Bridge",
"public" : true
}
Get the Tracker Associated with the Specified DOORS ModuleIn Codebeamer release 22.04 (FELICITY) and older: GET /doors/{module}/tracker[?options]
Since Codebeamer release 22.10-LTS (GINA) and newer: GET {CB}/rest/doors/bridge/{bridgeId}/module/{moduleId}/tracker[?options]
The result is information about the associated Codebeamer tracker, or null, if the specified module is not associated with any tracker. For example: GET /doors/bridge/12345/module/000000a0/tracker
{
"id" : 5130,
"type" : 5,
"path" : "Tracker",
"name" : "Pflichtenheft",
"title" : "",
"project" : {
"id" : 14,
"name" : "Test"
}
}
Get the DOORS Import Settings of the Specified TrackerGET /tracker/{trackerId}/doors/settings[?options]
You must be a Tracker Administrator, in order to get this information.
The result is a JSON object with information about the currently associated DOOORS module (if any), the import configuration and additional info to configure the import.
{
"id" : 83740,
"server" : {
"id" : 12345,
"server" : "http://my-doors-bridge:9090/db",
"description" : "DOORS 9.7 Bridge",
"public" : true
},
"username" : "Klaus"
"password" : "*****",
"module" : {
"id" : "00000020",
"type" : 3,
"name" : "Pflichtenheft",
"description" : "Ein Test Pflichenheft",
"path" : "/Klaus Test/Pflichtenheft",
"lock" : true,
"modify" : true
},
"enabled" : true,
"reliable" : false,
"lockModule" : true,
"linkObjects" : false,
"users" : true,
"fields" : [ {
"name" : "Created By",
"type" : 5,
"memberType" : 2,
"target" : 6
}, {
"name" : "Created On",
"type" : 3,
"target" : 4
}, {
"name" : "Last Modified By",
"type" : 5,
"memberType" : 2,
"target" : 75
},
...
],
"links" : [ {
"id" : "00000022",
"name" : "DOORS Links",
"description" : "Automatisch von DOORS erstelltes Linkmodul",
"attributes" : [ {
"name" : "Created By",
"type" : 5,
"memberType" : 2,
"target" : {
"id" : 6,
"name" : "Created by"
}
},
...
],
"target" : 1
}, {
"id" : "External",
"name" : "External",
"description" : "Links to external resources",
"attributes" : [ ... ],
"target" : 4
} ],
"interval" : "8:00h",
"log" : -1,
"userAdmin" : true,
"objectFields" : [ ... ],
"reservedFields" : [ ... ],
"dedicatedField" : { ... },
"designatedField" : { ... },
"assocTypes" : [ ... ],
"linkFields" : [ ... ]
}
The response also contains this additional information about the target tracker, that will be required to display and configure the users, fields and linkstarget mapping:
Set the DOORS Import Settings for the Specified TrackerPUT /tracker/{trackerId}/doors/settings
You must be a Tracker Administrator, in order to configure DOORS import for a tracker.
To build the fields and links mapping, you should use the attributes and linkTypes of the module: GET /doors/{module}/metaData[?options]
The fields mapping is an array of those module attributes, that you want to import, plus the target field mapping.
You can only import
if you are also importing users, which is only allowed, if you have userAdmin permission.
You can only assign DOORS user attributes {"type": 5, "memberType" : 2} , e.g. "Created By", to target member fields {"type": 5, "memberType" : 2} , e.g. "Submitted By", if you are importing users (see above).
The target of each attribute to import, is either one of the existing objectFields (the target field must be assignment compatible to the DOORS attribute and dedicatedFields can only be assigned to the specified attributes or not at all) "target" : {
"id" : ...
}
the designatedField, or, if there is no designated target field for the attribute, a new custom field with the specified name, e.g. "target" : {
"name" : "XXX"
}
The name XXX of new target fields must be unique within the tracker, so it must not be
The attribute target field mapping must be unique. No two DOORS attributes must be mapped to the same target field !
The choice option target mapping must be unique per target field. No two enum values of the same DOORS attribute must be mapped to the same choice option of the target field ! Remove the DOORS Import Settings for the Specified TrackerDELETE /tracker/{trackerId}/doors/settings
You must be a Tracker Administrator, in order to delete the DOORS import for a tracker. Create Target Trackers and Configure DOORS Import for a Bulk/Batch of DOORS ModulesWhat, if you want to import DOORS Modules into a Codebeamer project, but there is no appropriate target tracker yet ? POST /project/{projIdOrName}/doors/modules
You must be a Tracker Administrator in the specified project.
All modules in a batch should contain the same type of objects, e.g. Requirements, because you can only specify one template for the new target trackers.
To find out, which template trackers and tracker types are available for new DOORS import target trackers in the specified project, use: GET /project/{projIdOrName}/doors/trackerTemplate
This request is documented further down below.
You have to select either one of the available template trackers, e.g. "template" : {
"id" : <template id>,
"inherit" : true
}
where <template id> is the id of the template and inherit should be true to inherit the template configuration, or false to copy the template configuration.
Or, you have to specify the type of the new trackers, e.g. "template" : {
"type" : {
"id" : 5,
"name" : "Requirement"
}
}
To build the fields and links configuration, you have to get the merged/aggregated meta data of all the modules via GET /doors/{module}/metaData[?options]
where {module} should be the comma-separated list with the ids of all modules.
To get the necessary information about the defined, dedicated, designated, reserved and association fields, as well as association types, of the selected target template, use POST /project/{projIdOrName}/doors/trackerTemplate
where the request body must be the selected template.
For each module and it's new associated target tracker, only the fields and links, that are relevant for the module, will be used to build the tracker configuration.
The result is a JSON object, that contains the result for each of the specified modules (per module id). Either
From here on, you have to GET, PUT and DELETE the /tracker/{trackerId}/doors/settings for each tracker individually.
Get Information about the Next Import into the Specified Tracker from the Associated DOORS Module - If anyGET /tracker/{trackerId}/doors/import
You must have "Issue - Add" permission on the tracker.
{
"tracker" : {
"id" : 139792,
"type" : 5,
"name" : "Pflichtenheft",
"project" : {
"id" : 34,
"name" : "Test"
}
},
"admin" : true,
"server" : {
"id" : 12345,
"server" : "http://my-doors-bridge:9090/db",
"description" : "DOORS 9.7 Bridge",
"public" : true
},
"connection" : {
"server" : {
"id" : 12345,
"server" : "http://my-doors-bridge:9090/db",
"description" : "DOORS 9.7 Bridge",
"public" : true
},
"username" : "Klaus",
"password" : "***"
},
"module" : {
"id" : "00000020",
"name" : "Pflichtenheft",
"description" : "Ein Test Pflichenheft",
"path" : "/Klaus Test/Pflichtenheft",
"Last Modified On" : 1516292954,
"Last Modified By" : "Klaus",
"lockModule" : true,
"linkObjects" : true,
"baselines" : [ {
"id" : "0.1",
"description" : "Initialer Stand",
"Created On" : 1489143458020,
"Created By" : "Klaus",
"createdAt" : "Mär 10 2017 11:57"
}, {
"id" : "0.2",
"description" : "Zweiter Stand",
"Created On" : 1491820027020,
"Created By" : "Klaus",
"createdAt" : "Apr 10 2017 12:27"
} ],
"lastModifiedAt" : "Jan 18 17:29"
},
"enabled" : true,
"lastImport" : {
"date" : ...
},
"nextSync" : {
"direction" : null,
"date" : null
}
}
Do a New Import into the Specified Tracker from the Associated DOORS Module - If anyPOST /tracker/{trackerId}/doors/import
You must have "Issue - Add" permission on the tracker.
{
"baseline" : "0.1",
"mirroring" : true
}
In CB-9.4 and newer, and only when importing the current/head revision of a module, and only, if the module allows to lock the module and link objects, you can optionally request to lock the module and optionally link objects to imported tracker items:
{
"lockModule" : true,
"linkObjects" : true
}
The response body contains statistics about the imported DOORS objects. See the import statistics in the history below. Get the DOORS Import History of a TrackerGET /tracker/{trackerId}/doors/history[?options]
The response contains the requested page from the DOORS import history of the tracker, e.g.
{
"page" : 1,
"size" : 25,
"total" : 4,
"list" : [ {
"version" : 3,
"date" : "Heute 17:01",
"user" : {
"id" : 1,
"name" : "bond",
"realName" : "Default System Administrator"
},
"sync" : 1,
"baseline" : {
"id" : "0.2",
"date" : 1491820026993
},
"import" : {
"objects" : {
"imported" : 0,
"updated" : 6,
"updatedItems" : [ {
"id" : 7032,
"description" : "<span class='wikiContent'>Das ist ein <b>Beispiel</b>-Pflichtenheft zum Test des erweiterten Excel-Exports<br />\n<br /></span>",
"remote" : {
"id" : 16
},
"changes" : [ {
"fieldId" : 2,
"fieldName" : "Relevanz",
"oldValue" : "--",
"newValue" : "Wäre schön"
}, {
"fieldId" : 7,
"fieldName" : "Status",
"oldValue" : "--",
"newValue" : "Entwurf"
}, {
"fieldId" : 90,
"fieldName" : "Kommentar",
"op" : "Add",
"newValue" : "Weitere"
} ]
},
...
],
"deleted" : 0,
"failed" : 0
},
"history" : {
"imported" : 21,
"updated" : 0,
"deleted" : 0,
"failed" : 0,
"empty" : false
},
"links" : {
"imported" : 1,
"updated" : 0,
"deleted" : 0,
"failed" : 0,
"empty" : false
},
"baselines" : {
"imported" : 1,
"updated" : 0,
"deleted" : 0,
"failed" : 0,
"empty" : false
}
},
}, {
"version" : 2,
"date" : "Heute 17:00",
"user" : {
"id" : 1,
"name" : "bond",
"realName" : "Default System Administrator"
},
"sync" : 1,
"baseline" : {
"id" : "0.1",
"date" : 1489143458006
},
"import" : {
"objects" : {
"imported" : 13,
"updated" : 0,
"deleted" : 0,
"failed" : 0
},
"history" : {
"imported" : 39,
"updated" : 0,
"deleted" : 0,
"failed" : 0,
"empty" : false
},
"discussions" : {
"imported" : 2,
"updated" : 0,
"deleted" : 0,
"failed" : 0,
"empty" : false
},
"comments" : {
"imported" : 4,
"updated" : 0,
"deleted" : 0,
"failed" : 0,
"empty" : false
},
"attachments" : {
"imported" : 5,
"updated" : 0,
"deleted" : 0,
"failed" : 0,
"empty" : false
},
"baselines" : {
"imported" : 1,
"updated" : 0,
"deleted" : 0,
"failed" : 0,
"empty" : false
}
},
} ]
}
The history is in descending order. The first page contains the last/newest import information.
The statistics about the first/initial/full import only contain numbers. The statistics about incremental imports also contain information about newly imported items and updated items including changes per field.
Get Information about the Available Template Trackers and Tracker Types for new DOORS Import Target Trackers in the Specified ProjectGET /project/{projIdOrName}/doors/trackerTemplate
You must be a Tracker Administrator in the specified project.
The response body contains the possible types and the possible templates for DOORS import target trackers:
{
"types" : [ ... ],
"templates" : [ ... ]
}
Get Information about the Defined, Dedicated, Designated, Reserved and Association Fields, as well as Association Types of the Specified Import Target TemplatePOST /project/{projIdOrName}/doors/trackerTemplate
You must be a Tracker Administrator in the specified project.
{
"type" : {
"id" : 5,
"name" : "Requirement"
}
}
{
"enabled" : true,
"userAdmin" : true,
"objectFields" : [ ... ],
"reservedFields" : [ ... ],
"dedicatedField" : { ... },
"designatedField" : { ... },
"assocTypes" : [ ... ],
"linkFields" : [ ... ]
}
Get the Project Associated with the Specified DOORS Project or FolderIn Codebeamer release 22.04 (FELICTY) and older: GET /doors/{projectOrFolder}/project[?options]
Since Codebeamer release 22.10-LTS (GINA): GET /doors/bridge/{bridgeId}/folder/{projectOrFolder}/project[?options]
The result is information about the associated Codebeamer project, or null, if the specified DOORS project or folder is not associated with any project.
Get the DOORS Project or Folder Associated with the Specified ProjectGET /project/{projIdOrName}/doors/settings
You must be a Project Administrator, in order to get this information.
The result is a JSON object with information about the currently associated DOORS project or folder (if any):
{
"server" : {
"id" : 12345,
"server" : "http://my-doors-bridge:9090/db",
"description" : "DOORS 9.7 Bridge",
"public" : true
},
"username" : "Klaus",
"password" : "**",
"module" : {
"id" : "000000a1",
"type" : 2,
"name" : "Raw_Project_2",
"description" : "Just technical testing",
"path" : "/Mechatronics/Raw_Project_2"
}
}
"module" is the associated DOORS project or folder (and not a module). Set the DOORS Project or Folder Associated with the Specified ProjectPUT /project/{projIdOrName}/doors/settings
You must be a Project Administrator, in order to do this. Get Information about Baseline Sets, Defined on the Specified DOORS Project or Folder that can be Imported into the Specified ProjectIn Codebeamer release 22.04 (FELICITY) and older: GET /doors/{projectOrFolder}/baselineSets/project/{projIdOrName}[?options]
GET /project/{projIdOrName}/doors/{projectOrFolder}/baselineSets[?options]
Since Codebeamer release 22.10-LTS (GINA): GET /doors/bridge/{bridgeId}/folder/{projectOrFolder}/baselineSets/project/{projIdOrName}[?options]
GET /project/{projIdOrName}/doors/bridge/{bridgeId}/folder/{projectOrFolder}/baselineSets[?options]
You must be a Tracker Administrator in the specified project.
E.g. GET /project/Test/doors/bridge/12345/folder/000000a1/baselineSets?username=...&password=...
The response contains a JSON object with the following information:
{
"project" : {
"id" : 34,
"name" : "Test"
},
"trackers" : [ ... ],
"baselineSets" : [ {
"id" : "1.0.A-Sample",
"description" : "",
"Created On" : 1511964226905,
"Created By" : "Administrator",
"baselines" : {
"00000580" : "1.0.A-Sample",
"00000581" : "1.0.A-Sample"
},
"definition" : {
"name" : "BLSD_0",
"description" : "script generated set definition for 'A-Sample'"
},
"date" : 1511964895905,
"createdAt" : "Nov 29 2017 15:03",
"status" : "importable"
}, {
"id" : "1.0.B-Sample",
"description" : "",
"Created On" : 1511964240905,
"Created By" : "Administrator",
"baselines" : {
"00000580" : "2.0.B-Sample",
"00000581" : "2.0.B-Sample"
},
"definition" : {
"name" : "BLSD_1",
"description" : "script generated set definition for 'B-Sample'"
},
"date" : 1511965078905,
"createdAt" : "Nov 29 2017 15:04",
"status" : "importable"
}, {
"id" : "1.0.C-Sample",
"description" : "Administrator created set @ 29.11.2017 15:04:03",
"Created On" : 1511964249905,
"Created By" : "Administrator",
"baselines" : {
"00000580" : "3.0.C-Sample"
},
"definition" : {
"name" : "BLSD_2",
"description" : "script generated set definition for 'C-Sample'"
},
"date" : 1517317172905,
"createdAt" : "Nov 29 2017 15:04",
"status" : "importable"
}, {
"id" : "HEAD",
"Created By" : "System",
"Created On" : 1519123868444,
"baselines" : {
"00000580" : null,
"00000581" : null
},
"date" : 9223372036854775807,
"definition" : {
"name" : "Projekt/Ordner",
"description" : "Dies ist eine automatisch generierte Pseudo-Baselinegruppen-Definition, die alle (formalen) Module in dem ausgewählten DOORS Projekt/Ordner umfasst."
},
"description" : "Die aktuellen Versionen aller (formalen) Module in dem ausgewählten DOORS Projekt/Ordner",
"createdAt" : "Jetzt",
"status" : "importable"
} ],
"modules" : {
"00000580" : {
"id" : "00000580",
"name" : "RS",
"path" : "/Mechatronics/Raw_Project_2/RS",
"tracker" : {
"id" : 139791,
"type" : 5,
"name" : "Lastenheft",
"project" : {
"id" : 34,
"name" : "Test"
}
}
},
"00000581" : {
"id" : "00000581",
"name" : "TD",
"path" : "/Mechatronics/Raw_Project_2/TD"
}
}
}
Please note: Codebeamer automatically adds a pseudo baseline set "Projekt/Ordner - HEAD" to the baselineSets, whose baselines are the current/head revisions of all modules in the DOORS project/folder recursively, whether or not these modules are also included in "real" DOORS baseline sets, or there are no DOORS baseline sets at all. Get Information about the Necessary Steps to Import the Specified Baseline SetsPOST /doors/baselineSets
The result is an array of the importable baseline sets, each containing an array of the modules, that are associated with target trackers, and where baselines have to be imported.
Please note: Modules that are not associated with target trackers, or that have already been imported beyond the baseline/version in the baseline set, will be ignored!
E.g. When asking for the import steps for the baselineSets returned by the previous example, that each contained two modules, but where only one module (id="00000580") was associated with a tracker, and the other module (id="00000581") was not, then only the module with id="00000580" will be imported: [ {
"id" : "1.0.A-Sample",
"description" : "",
"Created On" : 1511964220,
"Created By" : "Administrator",
"definition" : {
"name" : "BLSD_0",
"description" : "script generated set definition for 'A-Sample'"
},
"date" : 1511964291910,
"modules" : [ {
"id" : "00000580",
"name" : "RS",
"description" : null,
"path" : "/Mechatronics/Raw_Project_2/RS",
"Last Modified On" : 1517471990,
"Last Modified By" : "Administrator",
"baselines" : [ {
"id" : "1.0.A-Sample",
"description" : "",
"Created On" : 1511964291910,
"Created By" : "Administrator",
"createdAt" : "Nov 29 2017 15:04"
} ],
"lastModifiedAt" : "Feb 01 08:59",
"tracker" : {
"id" : 139791,
"type" : 5,
"name" : "Lastenheft",
"project" : {
"id" : 34,
"name" : "Test"
}
}
} ]
}, {
"id" : "1.0.B-Sample",
"description" : "",
"Created On" : 1511964234,
"Created By" : "Administrator",
"definition" : {
"name" : "BLSD_1",
"description" : "script generated set definition for 'B-Sample'"
},
"date" : 1511965064910,
"modules" : [ {
"id" : "00000580",
"name" : "RS",
"description" : null,
"path" : "/Mechatronics/Raw_Project_2/RS",
"Last Modified On" : 1517471990,
"Last Modified By" : "Administrator",
"baselines" : [ {
"id" : "2.0.B-Sample",
"description" : "",
"Created On" : 1511965064910,
"Created By" : "Administrator",
"createdAt" : "Nov 29 2017 15:17"
} ],
"lastModifiedAt" : "Feb 01 08:59",
"tracker" : {
"id" : 139791,
"type" : 5,
"name" : "Lastenheft",
"project" : {
"id" : 34,
"name" : "Test"
}
},
"newerThan" : 1511964291910
} ]
}, {
"id" : "1.0.C-Sample",
"description" : "Administrator created set @ 29.11.2017 15:04:03:\nC sample comment\n",
"Created On" : 1511964243,
"Created By" : "Administrator",
"definition" : {
"name" : "BLSD_2",
"description" : "script generated set definition for 'C-Sample'"
},
"date" : 1517317172910,
"modules" : [ {
"id" : "00000580",
"name" : "RS",
"description" : null,
"path" : "/Mechatronics/Raw_Project_2/RS",
"Last Modified On" : 1517471990,
"Last Modified By" : "Administrator",
"baselines" : [ {
"id" : "3.0.C-Sample",
"description" : "Administrator created set @ 29.11.2017 15:04:03:\nC sample comment\n",
"Created On" : 1517317172910,
"Created By" : "Administrator",
"createdAt" : "Jan 30 13:59"
} ],
"lastModifiedAt" : "Feb 01 08:59",
"tracker" : {
"id" : 139791,
"type" : 5,
"name" : "Lastenheft",
"project" : {
"id" : 34,
"name" : "Test"
}
},
"newerThan" : 1511965064910
} ]
} ]
Get the Objects in a (Formal) DOORS Module (in a Specific Baseline)GET {DB}/module/{id}/objects[?options]
POST {DB}/module/{id}/objects
For a GET request, the options must be passed as request parameters. For a POST request, the options must be passed as a JSON object in the request body.
The response contains the module id, name, description, prefix and (DOORS Bridge 1.6 and newer) whether the module is actually locked, or if the user has permission to lock and modify the module, plus:
E.g. GET {DB}/module/00000020/objects?baseline=0.1&attributes=Created On,Created By,Last Modified On,Last Modified By,Status,users,attachments,discussions,history&links= 00000022;External
{
"id" : "00000020",
"name" : "Pflichtenheft",
"description" : "Ein Test Pflichenheft",
"prefix" : "PFL-",
"Created On" : 1487199600,
"Created By" : "Klaus",
"lock" : true,
"modify" : true,
"baseline" : {
"id" : "0.1",
"description" : "Initialer Stand",
"Created On" : 1489143451,
"Created By" : "Klaus"
},
"attributes" : {
"Created By" : 5,
"Created On" : 3,
"Last Modified By" : 5,
"Last Modified On" : 3,
"Status" : 6
},
"linkTypes" : {
"00000022" : {
"Created By" : 5,
"Created On" : 3,
"Last Modified By" : 5,
"Last Modified On" : 3
},
"External" : {
"Created By" : 5,
"Created On" : 3,
"Last Modified By" : 5,
"Last Modified On" : 3
}
},
"users" : [ {
"id" : "0000000000000002",
"name" : "Klaus",
"fullName" : "Klaus Mehling",
"email" : "klaus.mehling@intland.com"
} ],
"objects" : [ {
...
}, {
"id" : 16,
"type" : 1,
"pid" : 12,
"text" : "Das ist ein __Beispiel__-Pflichtenheft zum Test des erweiterten Excel-Exports\\\\
\\\\
",
"Created By" : "Klaus",
"Created On" : 1487199600,
"Last Modified By" : "Klaus",
"Last Modified On" : 1487331196,
"discussions" : [ {
"name" : "Improvements",
"status" : "Open",
"Created On" : 1488296724,
"Created By" : "Klaus",
"Last Modified On" : 1488297333,
"Last Modified By" : "Klaus",
"comments" : [ {
"date" : 1488296724,
"author" : "Klaus",
"text" : "Yes, but via Wiki markup, not RTF !"
}, {
"date" : 1488297333,
"author" : "Klaus",
"text" : "Do we support Rich Text ?"
} ]
} ],
"history" : [ {
"date" : 1487244491,
"author" : "Klaus",
"action" : "createObject"
}, {
"date" : 1487331196,
"author" : "Klaus",
"action" : "modifyObject",
"attribute" : "text",
"old" : "Das ist ein __Beispiel__-Pflichtenheft ...\\\\
\\\\
",
"new" : "Das ist ein __Beispiel__-Pflichtenheft zum Test des erweiterten Excel-Exports\\\\
\\\\
"
} ]
}, {
"id" : 18,
"type" : 1,
"pid" : 17,
"text" : "[1-1.doc|!1-1.png!]\\\\
@Copyright __Intland Software Gmbh__ 2017, ''All rights reseved''\\\\
",
"Created By" : "Klaus",
"Created On" : 1487199600,
"Last Modified By" : "Klaus",
"Last Modified On" : 1488899013,
"history" : [ {
"date" : 1487244775,
"author" : "Klaus",
"action" : "createObject"
}, {
"date" : 1488899013,
"author" : "Klaus",
"action" : "modifyObject",
"attribute" : "text",
"old" : "\\\\
\\\\
@Copyright __Intland Software Gmbh__ 2017, ''All rights reseved''\\\\
",
"new" : "\\\\
@Copyright __Intland Software Gmbh__ 2017, ''All rights reseved''\\\\
"
} ],
"attachments" : {
"1-1.doc" : "DP7/O18-T1-1.doc",
"1-1.png" : "DP7/O18-T1-1.png"
}
}, {
...
} ]
}
Known Problems
Get Information about the Necessary Steps to Import All Importable Baseline Sets Defined on the Specified DOORS Project or FolderIn Codebeamer release 22.04 (FELICTY) and older: GET /doors/{projectOrFolder}/baselineSets/steps[?options]
Since Codebeamer release 22.10-LTS (GINA): GET /doors/bridge/{bridgeId}/folder/{projectOrFolder}/baselineSets/steps[?options]
This gets information about the necessary steps to import all importable baseline sets defined on the specified DOORS project or folder into thecurrently associated target trackers of the modules included in those baseline sets.
If you need to verify the module tracker mappings/configurations first or select individual baseline sets to import, then you should first
then check module mappings and then
Import One or More Baseline SetsPOST /project/{projIdOrName}/doors/baselineSets
You must be a Tracker Administrator in the specified project.
The request body must contain either a single baseline set (JSON object) or an array of baseline sets, as returned from
|
codebeamer Overview codebeamer Knowledge Base Services by Intland Software |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This website stores cookies on your computer. These cookies are used to improve your browsing experience, constantly optimize the functionality and content of our website, furthermore helps us to understand your interests and provide more personalized services to you, both on this website and through other media. With your permission we and our partners may use precise geolocation data and identification through device scanning. You may click accept to consent to our and our partners’ processing as described above. Please be aware that some processing of your personal data may not require your consent, but you have a right to object to such processing. By using our website, you acknowledge this notice of our cookie practices. By accepting and continuing to browse this site, you agree to this use. For more information about the cookies we use, please visit our Privacy Policy
.Your preferences will apply to this website only.
anonymous
Hotkeys