Schema documentation for Reportable REST API
I'm using the Reportable REST API to pull information for artifacts in Doors Next 7.0.2./7.0.3. Is there documentation anywhere on the schema for the results returned, along with the meaning behind all the fields/attributes in the XML response? For example, I noticed that the values for custom attributes for the artifact are listed in the attribute:customAttribute elements like in the example shown below. But I also see that some of the attribute:customAttribute elements have different xml attributes. For example, in the example below the first attribute:customAttribute element has the attribute:isEnumeration, and attribute:literalName XML attributes, while the second doesn't. And the second attribute:customAttribute element has the attribute:valueTS while the first doesn't. Would be nice to have a list of all the XML attributes that an XML element in the results can have, along with their meaning to aid in parsing the data.
One answer
The schema for your artifact format can be retrieved from your server - this is documented on the DNG Reportable REST API page, search for "Get Schema"
Comments
Thanks. I called the schema endpoint and I am able to see the schema for attribute:customAttribute where it lists all the different fields. However the schema doesn't describe what the fields mean. While some of them are self explanatory, others like the one's I highlighted in red in the image below aren't. Are there examples anywhere for parsing through the data that explain the meaning of all the fields? Without the meaning there is no way to be sure that I am parsing the information correctly.
