Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Retrieving Document Details

Link: https://au.itwocx.com/api/latest24.08/api/help/index#!/Document/Document_GetById

By passing in a document id, potentially from a search result, you will get all the details of that document.

...

This can also be done in bulk by passing in a list of Ids:

https://au.itwocx.com/api/latest24.08/api/help/index#!/Document/Document_GetByIds

Creating a Document

Link: https://au.itwocx.com/api/latest24.08/api/help/index#!/Document/Document_Create

Properties
PropertyRequiredExampleNote(s)
DocCodeYesDEFUser needs to have permission to create forms of this type from.
StatusNameYesFOR REVIEWAs per Configure → Document Types → Form (e.g. DEF) → Status
TitleYesExample Title
ActionCodesNo["MC-MC"]An array of user codes. If blank will be the current user
InfoCodesNo["MC-PA","RIB-SS"]An array of user codes.
UserfieldValuesNo

[{"UserfieldCode": "LOC",

"Value": "/Z1/A01"}]

As per Configure → Document Types → Form (e.g. DEF) → User Fields

If the type of field is one with configured options (e.g. Select, Radio, Checkbox etc.), the value should be the option code to be selected.

...

Upon completion and if successful, the result will include the generated Id, Reference number and a link to it.

Updating a Document

Link: https://au.itwocx.com/api/latest24.08/api/help/index#!/Document/Document_Update

You can pass in a simple model with just the Document.Id and the value(s) you wish to change.

...