API methods
Integration Data manager uses the following methods.
createDocument
Signatures
com.guidewire.camel.idm.api.documents.IdmCreateDocumentResponse createDocument(String poolId, Integer schemaVersion, ObjectNode document)
com.guidewire.camel.idm.api.documents.IdmCreateDocumentResponse createDocument(String poolId, Integer schemaVersion, ObjectNode document, String searchKey)
Parameters
| Parameter | Description | Type |
|---|---|---|
| poolId | ID of the pool | String |
| document | Document body to add to the pool | ObjectNode |
| schema version | Version number of the schema | Integer |
| searchKey | Document search key | String |
deleteDocument
Signature
void deleteDocument(String poolId, String documentId)
Parameters
| Parameter | Description | Type |
|---|---|---|
| poolId | ID of the pool | String |
| documentId | ID of the document | String |
retrieveDocumentMetadataFirstPage
Signature
com.guidewire.camel.idm.api.documents.IdmRetrieveDocumentMetadataSinglePageResponse retrieveDocumentMetadataFirstPage(String poolId, Integer pageLimit)
Parameters
| Parameter | Description | Type |
|---|---|---|
| poolId | ID of the pool | String |
| pageLimit | Maximum number of items in the response page | Integer |
getDocumentsBySearchKey
Signatures
com.guidewire.camel.idm.api.documents.DocumentSearchResultPageResponse
getDocumentsBySearchKey(String poolId, String searchKey, Integer pageLimit,
Boolean forward)
com.guidewire.camel.idm.api.documents.DocumentSearchResultPageResponse
getDocumentsBySearchKey(String poolId, String searchKey, Integer pageLimit,
Boolean forward, String cursor)
Parameters
| Parameter | Description | Type |
|---|---|---|
| poolId | ID of the pool | String |
| searchKey | Document search key | String |
| pageLimit | Maximum number of items in the response page | Integer |
| forward | Whether the request is for the next items or the previous items,
where true means the next items and false means the previous items. Additionally, true returns the most recently created documents
first, and false returns the oldest documents first. |
Boolean |
| cursor | The cursor, which is null if making the first request, the previousCursor attribute of a previously received page when requesting the previous items before that page, or the nextCursor attribute of a previously received page when requesting the next items after that page. |
String |
retrieveDocument
Signature
com.guidewire.camel.idm.api.documents.IdmRetrieveDocumentResponse retrieveDocument(String poolId, String documentId)
Parameters
| Parameter | Description | Type |
|---|---|---|
| poolId | ID of the pool | String |
| documentId | ID of the document | String |
retrieveDocuments
Signature
Map<String documentId, Object documentContent> retrieveDocuments(String
poolId, List<String> documentIds)
Parameter
| Parameter | Description | Type |
|---|---|---|
| documentIds | List of document IDs | ArrayList |
updateDocumentMetadata
Signature
void updateDocumentMetadata(String poolId, String documentId, OffsetDateTime expiresAt)
Parameters
| Parameter | Description | Type |
|---|---|---|
| poolId | ID of the pool | String |
| documentId | ID of the document | String |
| expiresAt | Expiration date of the document | OffsetDateTime |