REST API base URL: https://
REST API objects URLs collection: https://
The following parameters are available for every API:
Many APIs return a "reference" object instead of returning a "full" object. References are the same type as a regular object, but the only piece of data filled out is the "ref" attribute in XML.
You can use the ref URL to get full information about the object.
Object read requests will return an XML or JSON document representing that object. In an XML response, all object fields will be included in the object output, even empty fields. With a JSON response, only non-empty fields will be included in the response, unless the “withEmpty” parameter is set.
If there is an error retrieving an object, the return element “Status” will indicate this with value "Error," and “Message” element will describe the error(s). Warnings can effectively be ignored, but the presence of errors indicates that the requested operation has failed.
A group of related records that are used and arranged in accordance with a filing system. These records are normally kept together because they relate to a particular subject or function, result from the same activity, have a particular form, or have some relationship arising from their creation, receipt, use, or disposition. They can be evaluated as a unit for retention scheduling purposes.
|mappings||To return all object mappings, you should set mappings=true. The API will return all object mapping references, unless fetch=true is set, in which case you will get object mapping data instead of just references. All mappings will be sorted by mapped object type.|
|guid||RecordClass object id|
REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass
REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/fbf31bf3-fd6c-aabd-4030-fede030e9b2b
REST URL: https://demo.igpolicy.net.com/p/api/services/restful/3.1/recordclass?start=20&pagesize=2&fetch=false
REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass?fetch=true&mappings=true&start=5&pagesize=1
|guid||DataOwner object id|
REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner
REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner/cfcf2086-6419-0c7c-90d5-3a75cb058017
|guid||DataSource object id|
REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/datasource
REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/datasource/e66bd933-68f6-da32-57c8-a6041f9a51ae
A record within the Citation Library that represents a legal or business obligation to retain a record. There are several types of citations.
|guid||Citation object id|
REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource
REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/citation/ed273e79-55d2-cd3d-ba2b-9c26feaf1582
REST URL: https://demo.igpolicy.net.com/p/api/services/restful/3.1/citation?start=17&pagesize=3&fetch=false
|mappings||To get information about all object mappings you should include mappings=true argument into your request string. So all object mappings will be included as a reference to mapped object. All mappings will be also sorted by mapped object type.|
|guid||Rule object id|
REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/rule
REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/rule/fb64420e-848d-2957-6bc4-9f1a216ca4e6
REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/rule?start=1&pagesize=2&fetch=true
REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/rule/fbdc0ff5-ad7f-419b-a23d-5703653e62b3?mappings=true
The changes API is intended to provide information about changes made between published versions of the API snapshot set in Policy Center.
String determines the type of change you want the API to return. Possible values are update, delete, create, and replace.
Update shows modified items, delete shows items that were deleted, create shows items created, and replace shows items where a rule tied to a specific jurisdiction and mapped to a record class is replaced by a mapping to a new rule in the same jurisdiction
|SnapshotTimeStamp||Unix timestamp. API will use this parameter only to compare with currently published snapshot. If sent SnapshotTimeStamp is equal to currently published SnapshotTimeStamp API will return ZERO changes. Otherwise—and it doesn’t matter how much snapshots have been published since SnapshotTimeStamp—API will return only list of most recent changes (changes which has happen during last API snapshot publishing).||YES|
The mappings API is intended to provide information about mapping objects—that is, the object that ties together a record class and a retention rule in Policy Center.
Mappings between Record Class and Rule have additional tag
|AA-01-001||- Record Class code|
|12345678||- Mapping code (Box code)|
|AA-01-001-12345678||- Classification Code|
|guid||Mapping object id|
|mapping_type||Mapping object type, e.g. “maprctorule”|