Policy center rest API

Policy Center Solution (PCS) REST API Overview

Starting point and URLs collection

REST API base URL: https://<domain>/p/api/services / restful/<version>

Example: https://demo.igpolicy.net/p/api/services/restful/3.1

REST API objects URLs collection: https:// <domain> / p/api /services/restful/ <version> / <object_type> / <guid>

Example: https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/fe68b798-04cf-4202-99b3-2352e47022d7

<domain> Policy Center client domain name (often something like company.igpolicy.net)
<version> is a current version of Policy Center product, e.g. 3.1;
<object_type> is an Policy Center retention object type, e.g. recordclass;
<guid> is an unique object identifier within Policy Center;

Global Parameters

The following parameters are available for every API:

fetch - can take true/ false values (default is false), indicates show only object reference or shows full list of object fields with values in output accordingly;
start - can take any positive integer value, indicates the position from what objects will be displayed in output;
pagesize - can take value from 1 to 100 (default is 20), indicates the amount of objects in result output;
responseFormat - API response format can be either XML or JSON
withEmpty – Note: this parameter can be used only when &responseFormat=json. By default empty metadata fields will not be included into API response. But if this parameter is set to 1 or ‘true’ – empty fields will not be stripped out from API response (Example https://pcs-api-hpe.igpolicy.net/p/api/services/restful/3.1/recordclass/94fe26b7-b584-ca35-cdb1-6198a965c282?responseFormat=json&withEmpty=true)

Differences between "reference" objects and "full" objects

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.

For instance: <citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource/311be25e-6029-879e-5c8b-4e0959d39e8d">

You can use the ref URL to get full information about the object.

Responses

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.

Services

RecordClass

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.

REST URLs Collection

Operation	HTTP Method	Encoding	URL
List	GET	XML	https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass
Read	GET	XML	https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/<guid>

Parameters:

Name	Description	Required
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

Examples:

REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass
RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<queryresults version="3.1">
<status>Success</status>
<message>Results from 1 to 20</message>
<startindex>1</startindex>
<pagesize>20</pagesize>
<totalresults>593</totalresults>
<snapshottimestamp>1474571044</snapshottimestamp>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/fbf31bf3-fd6c-aabd-4030-fede030e9b2b"></recordclass>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/0ce52998-e037-507f-6b0f-e4f0cdba2ffd"></recordclass>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/d322a9e7-0cb6-7045-0a01-1a6dbdd1efd7"></recordclass>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/350471c7-22a9-639b-0754-2177eebe910d"></recordclass>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/0d90882b-b75a-ec34-01af-d1843d4925be"></recordclass>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/3b89a5ff-51b0-59f1-3ac9-224693fdf28e"></recordclass>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/f9d99916-b009-5484-c633-8b5082daad84"></recordclass>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/29cc9cff-50ad-4cbc-d399-1bdcc1352fa4"></recordclass>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/bd47744e-cce2-b95c-3bff-fa81073aaa91"></recordclass>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/03c54e71-f859-eab9-9a7f-53f15f17f0a0"></recordclass>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/605791a1-83be-e389-3113-051c7fc7afbd"></recordclass>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/efae7e41-ab46-14cd-0998-413aedf5344d"></recordclass>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/e9038a55-9925-c96d-2e3e-2e351d4c423a"></recordclass>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/3e3c58ca-ff28-9bb6-a90b-da26e6cce31f"></recordclass>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/4a2ee82e-0cef-0b2e-6ed8-251dd2113688"></recordclass>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/15bd0053-f5ef-1e00-0029-63a4f9d3f3d0"></recordclass>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/1f493509-b5d4-7dd0-70f0-b2e75a075ae6"></recordclass>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/de891934-cf9b-48a9-874e-302b7078039d"></recordclass>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/4a84b166-40d6-6306-2e5c-f356db5f26fe"></recordclass>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/748fa78b-e928-9ad2-921e-6e64709375c5"></recordclass>
</queryresults>

REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/fbf31bf3-fd6c-aabd-4030-fede030e9b2b
RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<recordclass version="3.1">
<snapshottimestamp>1474571044</snapshottimestamp>
<guid>fbf31bf3-fd6c-aabd-4030-fede030e9b2b</guid>
<code>CR</code>
<name>Create Compliant Products</name>
<description></description>
<parent></parent>
<weight>2</weight>
<synonyms>
<value id="1">1</value>
<value id="2">2</value>
<value id="3">3</value>
</synonyms>
<state>Enabled</state>
<approveddate></approveddate>
<approvedby></approvedby>
<nonpreferredterms></nonpreferredterms>
<priority></priority>
<format>
</format>
<notes></notes>
<udf1></udf1>
<udf2></udf2>
<udf3></udf3>
<stewardship></stewardship>
<lastupdatedby></lastupdatedby>
<updateddate>2011-10-27</updateddate>
<retired></retired>
<attachments></attachments>
</recordclass>

REST URL: https://demo.igpolicy.net.com/p/api/services/restful/3.1/recordclass?start=20&pagesize=2&fetch=false
RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<queryresults version="3.1">
<status>Success</status>
<message>Results from 20 to 21</message>
<startindex>20</startindex>
<pagesize>2</pagesize>
<totalresults>593</totalresults>
<snapshottimestamp>1474571044</snapshottimestamp>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/748fa78b-e928-9ad2-921e-6e64709375c5"></recordclass>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/cf674a08-1888-a49d-fbaf-cf0f3940a452"></recordclass>
</queryresults>

REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass?fetch=true&mappings=true&start=5&pagesize=1
RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<queryresults version="3.1">
<status>Success</status>
<message>Results from 5 to 5</message>
<startindex>5</startindex>
<pagesize>1</pagesize>
<totalresults>593</totalresults>
<snapshottimestamp>1474571044</snapshottimestamp>
<recordclass>
<guid>0d90882b-b75a-ec34-01af-d1843d4925be</guid>
<code>CR-PRO</code>
<name>Product Management</name>
<description>Activities involved in creating compliant products and p/api/services including necessary approvals
thereof.</description>
<parent ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/fbf31bf3-fd6c-aabd-4030-fede030e9b2b"></parent>
<weight>3</weight>
<synonyms>
<value id="1">FTS</value>
<value id="2">STS</value>
<value id="3">TTS</value>
</synonyms>
<state>Enabled</state>
<approveddate></approveddate>
<approvedby></approvedby>
<nonpreferredterms></nonpreferredterms>
<priority></priority>
<format>
</format>
<notes></notes>
<udf1></udf1>
<udf2></udf2>
<udf3></udf3>
<stewardship></stewardship>
<lastupdatedby></lastupdatedby>
<updateddate>2011-10-27</updateddate>
<retired></retired>
<mappings>
<maprctosource ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctosource/c8848026-e6a2-9b65-b9
bd-d44911c1299">
<guid>c8848026-e6a2-9b65-b9bd-7d44911c1299</guid>
<boxcode>00018401</boxcode>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/219495c9-7db9-8edf-f5ec-8f
063e8306f1"></recordclass>
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/citation/7314b4b2-d3c9-f3fa-50f2-31086e426
320"></citation>
<justificationtext></justificationtext>
<wizard></wizard>
</maprctosource>
<maprctorule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/de6cb1a5-5bcc-9ab5-f2fc-df651
0082c65">
<guid>de6cb1a5-5bcc-9ab5-f2fc-df6510082c65</guid>
<boxcode>00000968</boxcode>
<classificationcode>BAE-001-00000968</classificationcode>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/197b35ef-dda0-2b94-1add-9
6902cc75727"></recordclass>
<rule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/rule/75552988-7b1e-8225-a0e7-f34a38dcaec1"></rule>
<justificationtext></justificationtext>
</maprctorule>
</mappings>
<attachments></attachments>
</recordclass>
</queryresults>

DataOwner

REST URLs Collection

Operation	HTTP Method	Encoding	URL
List	GET	XML	https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner
Read	GET	XML	https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner/<guid>

Parameters:

Name	Description	Required
guid	DataOwner object id

Examples:

REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner
RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<queryresults version="3.1">
<status>Success</status>
<message>Results from 1 to 20</message>
<startindex>1</startindex>
<pagesize>20</pagesize>
<totalresults>33</totalresults>
<snapshottimestamp>1474571044</snapshottimestamp>
<dataowner ref="https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner/cfcf2086-6419-0c7c-90d5-3a75cb058017"></dataowner>
<dataowner ref="https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner/a864a643-7152-d4e1-2e1c-0e77c75680fe"></dataowner>
<dataowner ref="https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner/8f3d732f-e93e-339a-8186-667b42900ab2"></dataowner>
<dataowner ref="https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner/eb5e6db7-4528-7793-a11f-17186557a2d3"></dataowner>
<dataowner ref="https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner/88b17e5b-9626-a685-8168-0851a8748c07"></dataowner>
<dataowner ref="https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner/314c1aae-049c-6c39-6f32-5c64c94652ca"></dataowner>
<dataowner ref="https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner/d9e57dbd-3642-bd9b-aa96-e60761ded8ff"></dataowner>
<dataowner ref="https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner/a6865a03-e055-78d4-29c2-2fabbb1607f1"></dataowner>
<dataowner ref="https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner/c9d61dd4-2345-5438-f04e-70203c9ef434"></dataowner>
<dataowner ref="https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner/21a53e46-26f9-6ce1-bb80-5f535d6610d9"></dataowner>
<dataowner ref="https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner/ae6e7744-48a0-4ce4-5e6b-bec58bf0488f"></dataowner>
<dataowner ref="https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner/cc3baa31-643f-9bee-7f6e-27a04596eb2e"></dataowner>
<dataowner ref="https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner/96df13df-615c-214d-8e3f-a20c37c7a743"></dataowner>
<dataowner ref="https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner/594fcf81-b752-2a8f-8d63-0c67a2053364"></dataowner>
<dataowner ref="https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner/c628f9b3-c780-5ecd-8876-cac648b4acfe"></dataowner>
<dataowner ref="https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner/4a9f8c23-277a-b195-cd32-7c8cd93c0aee"></dataowner>
<dataowner ref="https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner/5e009875-2fce-d195-d1c6-f3c07f2700af"></dataowner>
<dataowner ref="https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner/69a32d7d-c631-e391-18e5-37d5d8593754"></dataowner>
<dataowner ref="https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner/4af27935-f6e3-8759-d74c-ce74d1ad5b47"></dataowner>
<dataowner ref="https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner/772330d8-660b-9d7e-909c-a9e5d0208a0c"></dataowner>
</queryresults>

REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/dataowner/cfcf2086-6419-0c7c-90d5-3a75cb058017
RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<dataowner version="3.1">
<snapshottimestamp>1474571044</snapshottimestamp>
<guid>cfcf2086-6419-0c7c-90d5-3a75cb058017</guid>
<code>001</code>
<parent></parent>
<weight>0</weight>
<name>Corportate HQ</name>
<role>Organizational Unit</role>
<type>Group</type>
<description></description>
<state>Enabled</state>
<approveddate>2012-11-27</approveddate>
<approvedby></approvedby>
</dataowner>

DataSource

REST URLs Collection

Operation	HTTP Method	Encoding	URL
List	GET	XML	https://demo.igpolicy.net/p/api/services/restful/3.1/datasource
Read	GET	XML	https://demo.igpolicy.net/p/api/services/restful/3.1/datasource/<guid>

Parameters:

Name	Description	Required
guid	DataSource object id

Examples:

REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/datasource
RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<queryresults version="3.1">
<status>Success</status>
<message>Results from 1 to 5</message>
<startindex>1</startindex>
<pagesize>20</pagesize>
<totalresults>5</totalresults>
<snapshottimestamp>1474571044</snapshottimestamp>
<datasource ref="https://demo.igpolicy.net/p/api/services/restful/3.1/datasource/e66bd933-68f6-da32-57c8-a6041f9a51ae"></datasource>
<datasource ref="https://demo.igpolicy.net/p/api/services/restful/3.1/datasource/36b30de0-c549-b9ee-9d42-77887132b225"></datasource>
<datasource ref="https://demo.igpolicy.net/p/api/services/restful/3.1/datasource/5f62f05e-3d4b-a5c8-7085-8526bcece6ff"></datasource>
<datasource ref="https://demo.igpolicy.net/p/api/services/restful/3.1/datasource/085574c6-705d-6e45-15c7-3ccc8f7ffb18"></datasource>
<datasource ref="https://demo.igpolicy.net/p/api/services/restful/3.1/datasource/6c7bd0b7-5cdc-cd66-5c09-49c5e219dfea"></datasource>
</queryresults>

REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/datasource/e66bd933-68f6-da32-57c8-a6041f9a51ae
RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<datasource version="3.1">
<guid>e66bd933-68f6-da32-57c8-a6041f9a51ae</guid>
<snapshottimestamp>1474571044</snapshottimestamp>
<code>00001</code>
<name>Business Analysis Database</name>
<description>Business Analysis Database Description</description>
<category>
<value id="1">Online Repositories</value>
<value id="2">Backup</value>
</category>
<jurisdiction>
<value id="1">Global</value>
</jurisdiction>
<uri></uri>
<notes></notes>
<state>Enabled</state>
<approveddate>2012-11-27</approveddate>
<approvedby></approvedby>
<preservationorder>Hold</preservationorder>
<status>Online</status>
<operationalbegindate>2012-11-27</operationalbegindate>
<operationalenddate>2012-11-27</operationalenddate>
</datasource>

Citations

A record within the Citation Library that represents a legal or business obligation to retain a record. There are several types of citations.

GRS Citation: Digital copies of citations delivered from the GRS database. Only a limited number of fields can be edited on a GRS citation.
Local Citation: Citations created locally within PCS and not part of a GRS subscription.

REST URLs Collection

Operation	HTTP Method	Encoding	URL
List	GET	XML	https://demo.igpolicy.net/p/api/services/restful/3.1/citation
Read	GET	XML	https://demo.igpolicy.net/p/api/services/restful/3.1/citation/<guid>

Parameters:

Name	Description	Required
guid	Citation object id

Examples:

REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource
RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<queryresults version="3.1">
<status>Success</status>
<message>Results from 1 to 20</message>
<startindex>1</startindex>
<pagesize>20</pagesize>
<totalresults>5125</totalresults>
<snapshottimestamp>1474571044</snapshottimestamp>
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource/ed273e79-55d2-cd3d-ba2b-9c26feaf1582"></citation>
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource/a88fa25f-4d48-3937-28a3-f2c6f4f9cca8"></ Citation>
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource/ee3a8be8-ea0b-805d-8e62-a23b1da0265a"></citation>
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource/9fc2006c-133c-10f9-04e5-a13e26614ec9"></ Citation >
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource/a1b2d1e3-b418-5755-7cc4-332f12585435"></citation>
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource/5ced4fc7-ec0d-49c7-002a-e0fc0d4c2e44"></citation>
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource/60cab2ec-fc6c-deef-6881-715ac910d37e"></citation>
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource/f807fb6d-d735-be0d-03aa-8009692bf765"></citation>
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource/6ef401c3-5e5d-42f1-c1ff-13fecf671a41"></citation>
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource/2bb2a1a8-bfa1-c554-0a15-691471a47fa6"></citation>
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource/a6cb2af9-09b5-c61e-fc38-7a920d7823e8"></citation>
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource/ab73e5e2-e221-59c6-20d3-8ebd8bc5decb"></citation>
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource/a8af12a1-b2f5-416f-fa20-93fd49a58938"></citation>
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource/0fb2596f-1050-133c-6d29-805b40dfe9f4"></citation>
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource/21c07af6-cc47-1a72-e45b-d6438fc771e4"></citation>
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource/5c0f5bae-1e15-cfed-555f-6e51aa9bdab9"></citation>
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource/311be25e-6029-879e-5c8b-4e0959d39e8d"></citation>
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource/b9e2a4ae-cb80-3344-a01f-56973d2a174b"></citation>
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource/d69b3f64-1363-801a-f971-8fe0ef8f0beb"></citation>
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource/c4781b5c-94be-5206-6ffa-f24af5ea5e25"></citation>
</citation></citation></queryresults>

REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/citation/ed273e79-55d2-cd3d-ba2b-9c26feaf1582
RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<citation version="3.1">
<snapshottimestamp>1474571044</snapshottimestamp>
<guid>ed273e79-55d2-cd3d-ba2b-9c26feaf1582</guid>
<code>GLOBAL-ALL-0036</code>
<jurisdiction>Global</jurisdiction>
<title>AA_1</title>
<sectionsubsection></sectionsubsection>
<heading>
</heading>
<name>n.a.</name>
<summary>Retention is not regulated per Group Taxonomy but by legal requirement and policy applicable in Business
Division and Location.</summary>
<state>Enabled</state>
<approveddate></approveddate>
<approvedby></approvedby>
<legalstatusstate>Active</legalstatusstate>
<begindate></begindate>
<enddate></enddate>
<retentiontype>Legacy</retentiontype>
<legalindex></legalindex>
<sourceobject></sourceobject>
<recordsaffected></recordsaffected>
<retentiontrigger></retentiontrigger>
<dispositiontrigger>n.a.</dispositiontrigger>
<minperiod>n.a</minperiod>
<minperiodrational></minperiodrational>
<minperiodrationalunits>years</minperiodrationalunits>
<maxperiod>n.a.</maxperiod>
<maxperiodrational></maxperiodrational>
<maxperiodrationalunits>years</maxperiodrationalunits>
<accessperiod>Undefined</accessperiod>
<accessperiodrational></accessperiodrational>
<accessperiodrationalunits>years</accessperiodrationalunits>
<accessingauthority></accessingauthority>
<enforcementagency>N.A.</enforcementagency>
<relatedrequirements><![CDATA[Undefined]]></relatedrequirements>
<urltocitationtext></urltocitationtext>
<citationtext><![CDATA[]]></citationtext>
<notes></notes>
<lastmajorupdate></lastmajorupdate>
<lastmajorupdateby></lastmajorupdateby>
<lastreviewed></lastreviewed>
<dataprovider>manually added</dataprovider>
<attachments></attachments>
</citation>

REST URL: https://demo.igpolicy.net.com/p/api/services/restful/3.1/ citation ?start=17&pagesize=3&fetch=false
RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<queryresults version="3.1">
<status>Success</status>
<message>Results from 17 to 19</message>
<startindex>17</startindex>
<pagesize>3</pagesize>
<totalresults>5125</totalresults>
<snapshottimestamp>1474571044</snapshottimestamp>
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource/311be25e-6029-879e-5c8b-4e0959d39e8d"></citation>
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource/b9e2a4ae-cb80-3344-a01f-56973d2a174b"></citation>
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/legalsource/d69b3f64-1363-801a-f971-8fe0ef8f0beb"></citation>
</queryresults>

Rule

REST URLs Collection

Operation	HTTP Method	Encoding	URL
List	GET	XML	https://demo.igpolicy.net/p/api/services/restful/3.1/rule
Read	GET	XML	https://demo.igpolicy.net/p/api/services/restful/3.1/rule/<guid>

Parameters:

Name	Description	Required
mappings	To get information about all object mappings you should include mappi ngs=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

Examples:

REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/rule
RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<queryresults version="3.1">
<status>Success</status>
<message>Results from 1 to 20</message>
<startindex>1</startindex>
<pagesize>20</pagesize>
<totalresults>365</totalresults>
<snapshottimestamp>1474571044</snapshottimestamp>
<rule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/rule/fb64420e-848d-2957-6bc4-9f1a216ca4e6"></rule>
<rule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/rule/8e2ce550-a639-f5f5-7bf9-ecac2eb5095c"></rule>
<rule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/rule/d9022970-53f5-9837-e210-8108e2a496ce"></rule>
<rule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/rule/4e8a144e-deae-8f5e-dc17-01e290df4cfd"></rule>
<rule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/rule/a6381164-406a-ca8c-bdb9-3deceb1f073b"></rule>
<rule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/rule/43b9d71d-a015-ef38-1065-631eb156e6d6"></rule>
<rule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/rule/2165ce79-759b-bd9f-79a1-a43dbf585207"></rule>
<rule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/rule/6becd287-11ae-139e-37e9-99c68354ed02"></rule>
<rule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/rule/19b4251c-2b8d-363b-26c6-83b0a0922105"></rule>
<rule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/rule/8c1f7666-eeaa-2b05-addf-7adb22bd1158"></rule>
<rule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/rule/4d02b038-f016-07cc-5a90-eb4a288c4302"></rule>
<rule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/rule/fd59b4dd-e152-5b10-2e0b-d16491b51d8e"></rule>
<rule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/rule/e4daf766-d892-c599-fc39-f73ab5d62e57"></rule>
<rule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/rule/7d4b4bd2-6b2b-e417-a86d-3efc510e6af0"></rule>
<rule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/rule/ddf2e692-4e5b-231d-207d-fd0deead1f94"></rule>
<rule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/rule/74a823b8-bfb3-3536-709a-5400d5d51892"></rule>
<rule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/rule/a37eca7c-b0ab-512d-2606-d091a2e77521"></rule>
<rule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/rule/eb287404-876c-b234-a584-4a9637f2bcab"></rule>
<rule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/rule/99ec7f6c-c7e3-411e-8c2f-110a13ea1091"></rule>
<rule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/rule/04087969-f8c5-d6ed-08ea-bc53c9b782cd"></rule>
</queryresults>

REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/rule/fb64420e-848d-2957-6bc4-9f1a216ca4e6
RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<rule version="3.1">
<snapshottimestamp>1474571044</snapshottimestamp>
<guid>fb64420e-848d-2957-6bc4-9f1a216ca4e6</guid>
<code>rr-AT-ALL-0001</code>
<jurisdiction>AT</jurisdiction>
<name>AT End of employment 30 year(s)</name>
<retentiontrigger></retentiontrigger>
<dispositiontrigger>End of employment</dispositiontrigger>
<minperiod>30 year(s)</minperiod>
<minperiodrational></minperiodrational>
<minperiodrationalunits>years</minperiodrationalunits>
<maxperiod></maxperiod>
<operationalstorageperiod></operationalstorageperiod>
<dispositionaction></dispositionaction>
<state>Enabled</state>
<approveddate></approveddate>
<approvedby>UBS Legacy</approvedby>
<attachments></attachments>
</rule>

REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/rule?start=1&pagesize=2&fetch=true
RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<queryresults version="3.1">
<status>Success</status>
<message>Results from 1 to 2</message>
<startindex>1</startindex>
<pagesize>2</pagesize>
<totalresults>365</totalresults>
<snapshottimestamp>1474571044</snapshottimestamp>
<rule>
<guid>fb64420e-848d-2957-6bc4-9f1a216ca4e6</guid>
<code>AT-ALL-0001</code>
<jurisdiction>AT</jurisdiction>
<name>AT End of employment 30 year(s)</name>
<retentiontrigger></retentiontrigger>
<dispositiontrigger>End of employment</dispositiontrigger>
<minperiod>30 year(s)</minperiod>
<minperiodrational></minperiodrational>
<minperiodrationalunits>years</minperiodrationalunits>
<maxperiod></maxperiod>
<operationalstorageperiod></operationalstorageperiod>
<dispositionaction></dispositionaction>
<state>Enabled</state>
<approveddate></approveddate>
<approvedby>Fontis Legacy</approvedby>
<attachments></attachments>
</rule>
<rule>
<guid>8e2ce550-a639-f5f5-7bf9-ecac2eb5095c</guid>
<code>AT-ALL-0002</code>
<jurisdiction>AT</jurisdiction>
<name>AT End of year of creation/ receipt 10 year(s)</name>
<retentiontrigger></retentiontrigger>
<dispositiontrigger>End of year of creation/ receipt</dispositiontrigger>
<minperiod>10 year(s)</minperiod>
<minperiodrational></minperiodrational>
<minperiodrationalunits>years</minperiodrationalunits>
<maxperiod></maxperiod>
<operationalstorageperiod></operationalstorageperiod>
<dispositionaction></dispositionaction>
<state>Enabled</state>
<approveddate></approveddate>
<approvedby>Fontis Legacy</approvedby>
<attachments></attachments>
</rule>
</queryresults>

REST URL: https://demo.igpolicy.net/p/api/services/restful/3.1/rule/fbdc0ff5-ad7f-419b-a23d-5703653e62b3?mappings=true
RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<rule version="3.1">
<guid>fbdc0ff5-ad7f-419b-a23d-5703653e62b3</guid>
<snapshottimestamp>1474571044</snapshottimestamp>
<code>rr-AT-ALL-0004</code>
<jurisdiction>AT</jurisdiction>
<name>Rule</name>
<retentiontrigger>Send to historical Archiv</retentiontrigger>
<dispositiontrigger>Control check</dispositiontrigger>
<minperiod>5 years</minperiod>
<minperiodrational>5</minperiodrational>
<minperiodrationalunits>years</minperiodrationalunits>
<maxperiod>10 years</maxperiod>
<operationalstorageperiod>7 years</operationalstorageperiod>
<dispositionaction>Delete it before the read</dispositionaction>
<state>Enabled</state>
<approveddate>2012-12-18</approveddate>
<approvedby>Big boss</approvedby>
<mappings>
<maprctorule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/3b89a5ff-51b0-59f1-3ac9-224693fdf28e"></maprctorule>
</mappings>
<attachments></attachments>
</rule>

Changes

The changes API is intended to provide information about changes made between published versions of the API snapshot set in Policy Center.

Parameters:

Name

Description

Required

type

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

Example Request:

https://demo.igpolicy.net/p/api/services/restful/3.1/changes

Example Response:

<queryresults version="3.1">
<status>Success</status>
<message>Results from 1 to 1</message>
<startindex>1</startindex>
<pagesize>20</pagesize>
<totalresults>4</totalresults>
<snapshottimestamp>1474417625</snapshottimestamp>
<change type="delete" guid="197b35ef-dda0-2b94-1add-96902cc75727" ctype="rule"></change>
<change type="create" guid="816cfbd1-a633-39fa-d5f6-8d91334f0c2f" ctype="recordclass" ref="https://demo.igpolicy.net
/p/api/services/restful/3.1/recordclass/816cfbd1-a633-39fa-d5f6-8d91334f0c2f"></change>
<change type="update" guid="de63ddd5-d8ea-0224-38b0-877b4e27b569" ctype="recordclass" ref="https://demo.igpol
icy.net/p/api/services/restful/3.1/recordclass/de63ddd5-d8ea-0224-38b0-877b4e27b569"></change>
<change type="replace" guid="197b35ef-dda0-2b94-1add-96902cc75727" ctype="recordclass" jurisdiction="https://demo.igpolicy.net/p/api/services/restful/3.1/jurisdiction/d3fc8a0f-c0fe-11e4-811c-22000b17946a" ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/197b35ef-dda0-2b94-1add-96902cc75727">
<change type="delete" guid="004cd9d7-3ca1-d811-1da6-2f972d1afc3e" ctype="maprctorule"></change>
<change type="create" guid="0be566e2-a51a-7871-98a9-bb51ef16e135" ctype="maprctorule" ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/0be566e2-a51a-7871-98a9-bb51ef16e135"></change>
</change>
</queryresults>

Example Request:

https://demo.igpolicy.net/p/api/services/restful/3.1/changes? fetch=true

Example Response:

<queryresults version="3.1">
<status>Success</status>
<message>Results from 1 to 1</message>
<startindex>1</startindex>
<pagesize>20</pagesize>
<totalresults>4</totalresults>
<snapshottimestamp>1474417625</snapshottimestamp>
<change type="delete" guid="197b35ef-dda0-2b94-1add-96902cc75727" ctype="rule"></change>
<change type="create" guid="c95671c2-77bc-5ac4-8513-87da5d94f00d" ctype="rule" ref="https://hpe.loc/p/api/services/restful/3.1/rule/c95671c2-77bc-5ac4-8513-87da5d94f00d">
<guid>c95671c2-77bc-5ac4-8513-87da5d94f00d</guid>
<code>AD-ALL-0002</code>
<jurisdiction>AD</jurisdiction>
<name>Test Rule</name>
<retentiontrigger></retentiontrigger>
<trigger>
The date the record is created
</trigger>
<minperiod>6 Years<minperiod></minperiod>
<minperiodrational>6<minperiodrational></minperiodrational>
<minperiodrationalunits>years</minperiodrationalunits>
<maxperiod></maxperiod>
<operationalstorageperiod></operationalstorageperiod>
<dispositionaction></dispositionaction>
<state>Enabled</state>
<approveddate></approveddate>
<approvedby></approvedby>
<attachments></attachments>
</minperiodrational></minperiod></change>
<change type="update" guid="de63ddd5-d8ea-0224-38b0-877b4e27b569" ctype="recordclass" ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/de63ddd5-d8ea-0224-38b0-877b4e27b569"></change>
<state>Disabled</state>
<change type="replace" guid="197b35ef-dda0-2b94-1add-96902cc75727" ctype="recordclass" jurisdiction="https://demo.igpolicy.net/p/api/services/restful/3.1/jurisdiction/d3fc8a0f-c0fe-11e4-811c-22000b17946a" ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/197b35ef-dda0-2b94-1add-96902cc75727">
<change type="delete" guid="004cd9d7-3ca1-d811-1da6-2f972d1afc3e" ctype="maprctorule"></change>
<change type="create" guid="0be566e2-a51a-7871-98a9-bb51ef16e135" ctype="maprctorule" ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/0be566e2-a51a-7871-98a9-bb51ef16e135"></change>
</change>
</queryresults>

Example Request:

https://demo.igpolicy.net/p/api/services/restful/3.1/changes?type=replace

Example Response:

<queryresults version="3.1">
<status>Success</status>
<message>Results from 1 to 1</message>
<startindex>1</startindex>
<pagesize>20</pagesize>
<totalresults>1</totalresults>
<snapshottimestamp>1474417625</snapshottimestamp>
<change type="replace" guid="197b35ef-dda0-2b94-1add-96902cc75727" ctype="recordclass" jurisdiction="https://demo.igpolicy.net/p/api/services/restful/3.1/jurisdiction/d3fc8a0f-c0fe-11e4-811c-22000b17946a" ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/197b35ef-dda0-2b94-1add-96902cc75727">
<change type="delete" guid="004cd9d7-3ca1-d811-1da6-2f972d1afc3e" ctype="maprctorule"></change>
<change type="create" guid="0be566e2-a51a-7871-98a9-bb51ef16e135" ctype="maprctorule" ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/0be566e2-a51a-7871-98a9-bb51ef16e135"></change>
</change>
</queryresults>

Mappings

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 based on Record Class code and Mapping code (Box code).

example:

AA-01-001	- Record Class code
12345678	- Mapping code (Box code)
AA-01-001-12345678	- Classification Code

REST URLs Collection

Operation	HTTP Method	Encoding	URL
List	GET	XML	https://demo.igpolicy.net/p/api/services/restful/3.1/<mapping_type>
Read	GET	XML	https://demo.igpolicy.net/p/api/services/restful/3.1/<mapping_type> /<guid>

Parameters:

Name	Description	Required
guid	Mapping object id
mapping_type	Mapping object type, e.g. “maprctorule”

Example Request:

https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule

Example Response:

<queryresults version="3.1">
<status>Success</status>
<message>Results from 1 to 20</message>
<startindex>1</startindex>
<pagesize>20</pagesize>
<totalresults>794</totalresults>
<snapshottimestamp>1474571044</snapshottimestamp>
<maprctorule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/c759aa59-af2e-ad5e-23b6-171eef21eeb3"></maprctorule>
<maprctorule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/1074de71-72a5-b80a-149d-17d728645e96"></maprctorule>
<maprctorule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/34658c3a-03ea-d685-9756-2f0873e378e0"></maprctorule>
<maprctorule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/bd9051d2-5970-40e8-562e-4a38381afe2a"></maprctorule>
<maprctorule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/b6e799f8-11f4-ed6a-f1f4-6b6b12c5284c"></maprctorule>
<maprctorule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/59dbb117-e6d5-a4e0-611d-a9397cdfebd9"></maprctorule>
<maprctorule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/90d9d300-729e-d8af-0fa1-7931171f4909"></maprctorule>
<maprctorule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/e2b49222-07e8-196a-1f28-77668bab59b1"></maprctorule>
<maprctorule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/752d5136-c3f5-99c8-1b44-aed0f7d33bd1"></maprctorule>
<maprctorule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/e796ef04-e728-fbda-e737-57a86eab1aeb"></maprctorule>
<maprctorule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/a70a9654-9a33-35f0-8f51-8f3552b7f05a"></maprctorule>
<maprctorule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/645be058-d1b7-840d-1a46-2c9a963723c3"></maprctorule>
<maprctorule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/19583797-f704-ce31-432b-3e43d69bc37d"></maprctorule>
<maprctorule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/82d1ee08-7bc2-eafc-4b8b-6d57a740703d"></maprctorule>
<maprctorule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/7497ca1f-972a-87eb-f500-005bb4aabfd9"></maprctorule>
<maprctorule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/e7318463-4dcb-0ba9-7895-ca371875c7de"></maprctorule>
<maprctorule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/2e1f4d1f-9757-72f8-5823-83d8b2bb60fe"></maprctorule>
<maprctorule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/3c51fc2f-c9c9-0160-35ec-b84656eed114"></maprctorule>
<maprctorule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/e560adfd-d0c4-e4c8-7461-fa6dfa9b1c56"></maprctorule>
<maprctorule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/a6acbff0-27fc-6956-b652-6a0918688380"></maprctorule>
</queryresults>

Example Request:

https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/1e1c4f60-264f-3c06-6e95-7f5ab7ecd41c

Example Response:

<maprctorule version="3.1" ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctorule/1e1c4f60-264f-3c06-6e95-7f5ab7ecd41c">
<snapshottimestamp>1474417625</snapshottimestamp>
<guid>1e1c4f60-264f-3c06-6e95-7f5ab7ecd41c</guid>
<boxcode>00000930</boxcode>
<classificationcode>COE-004-00000930</classificationcode>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/588d0e71-ede9-6637-d4d3-e86cf13b7d0c"></recordclass>
<rule ref="https://demo.igpolicy.net/p/api/services/restful/3.1/rule/01f0f1e8-9939-425c-0386-674a114c37bb"></rule>
<justificationtext></justificationtext>
</maprctorule>

Example Request for mapping between Record Class and Source :

https://demo.igpolicy.net/p/api/services/restful/3.1/maprctosource/f27e49a6-45b7-99de-4c2c-2d497cea624d

Example Response:

<maprctosource version="3.1" ref="https://demo.igpolicy.net/p/api/services/restful/3.1/maprctosource/f27e49a6-45b7-99de4c2c-2d497cea624d">
<snapshottimestamp>1474041256</snapshottimestamp>
<guid>f27e49a6-45b7-99de-4c2c-2d497cea624d</guid>
<boxcode>00000008</boxcode>
<recordclass ref="https://demo.igpolicy.net/p/api/services/restful/3.1/recordclass/8e8ffa14-cd29-c8a4-b6d6-04a3304a54c7"></recordclass>
<citation ref="https://demo.igpolicy.net/p/api/services/restful/3.1/citation/7a70686e-9391-1829-107e-bb28166b5b07"></citation>
<justificationtext></justificationtext>
<wizard>1</wizard>
</maprctosource>

Run The Browser Test

Policy center rest API

Support

Policy Center Solution (PCS) REST API Overview

Starting point and URLs collection

Global Parameters

Differences between "reference" objects and "full" objects

Responses

Services

RecordClass

REST URLs Collection

Parameters:

Examples:

DataOwner

REST URLs Collection

Parameters:

Examples:

DataSource

REST URLs Collection

Parameters:

Examples:

Citations

REST URLs Collection

Parameters:

Examples:

Rule

REST URLs Collection

Parameters:

Examples:

Changes

Parameters:

Example Request:

Example Response:

Example Request:

Example Response:

Example Request:

Example Response:

Mappings

REST URLs Collection

Parameters:

Example Request:

Example Response:

Example Request:

Example Response:

Example Request for mapping between Record Class and Source :

Example Response: