Inserting a Document using Post-Assembly Processing

When post-assembly processing you may need to append or insert a document into your assembled documents using an API call.  For example, if you need to add a standard disclaimer already held in your system into the set of documents produced by Advance.

Using the endpoints and parameters, you can determine where your document should be placed.

API Endpoints


[PUT] /Workitems/{workitemId}/versions/active/documents/{documentId}/Content
[PUT] /WorkItems/{workItemId}/Versions/{versionId}/Documents/{documentId}/Content?filename={text}&name={text}[optional]&assembledorder={int}[optional]

Parameters

  • assembledorder: Specifies the order of the document.
    • 0: Prepended
    • 1: Inserted at the second position, incrementing the existing document up one.
    • If the assembledorder index is greater than the highest index in the current list, it is appended with an assembly order of n+1, where n was the previous highest assembledorder.