Change Management REST API Specification (Future Concepts)

(Concepts to consider to future specification work)

SPECIFICATION NOTES: This document is intented to capture REST API concepts that will not be part of the initial core services. The intent is to keep the specifications as simple as possible, expanding on the needs as user stories support it. See the core specification document for current specification work.

Working with Collections

• search and query parameters
• format requested: XML, HTML, JSON
• feeds

Getting a Resource

• Formats supported: XML, HTML, JSON, etc
• Requesting formats: Accept header, parameter
• Inline content vs. references

Creating New Resources

• Resource definition discovery: what elements are needed to be supplied?
• Error handling: constraints aren't satisfied, missing depedent fields, etc?

Updating Resources

• Typical CM tools support actions on resources, how do these surface?
• Communicating the workflow model of resources: accept task, resolve, close, duplicate, promote to next state, etc
• Requesting forms directly: no-frames, HTML
• Error handling: responses that can be consumable by tools (and humans)