Using the RESTConnect API
Who is this article for?
Enterprise or Decani Administrators and Interface Developers who need to access data programmatically using a RESTConnect API interface.
Restricted access to Users with interface development roles.
Overview
RESTConnect is the REST API for the Ideagen EHSQ platform. It lets external systems and integrations work with the data in your application without using the user interface. Requests are sent over HTTPS to resource paths built from your subscriber and module codes, and data is exchanged as JSON or XML.
With RESTConnect you can:
- Create, retrieve, search, update, and delete module records. See Module Objects.
- Add, update, and delete rows in a record's child levels. See Child Level Data.
- Upload, download, replace, and delete attachment files, including field attachments. See Attachments and Field Attachments.
- Generate PDF printouts of a record. See Print Resource.
- Run a user's saved searches and retrieve subscriber information. See Search Resource and Subscriber Resource.
Each request is independent and must be authenticated, either with Basic authentication or with a session token returned by an earlier authenticated call. See Security.
Base URL: https://rest-config.Ideagen.com/RESTConnect/rest/v2
Obtaining your area's Base URL
Users with the Interface Developer administrative role can find the RESTConnect Base URL for the area on the Incoming Web Services admin screen.
Each module can also generate its own reference. See Module Documentation.
The platform supports four HTTP verbs for module objects: GET, POST, PUT, and DELETE. HEAD is also supported. Use Accept-Encoding: gzip for smaller response payloads.
| HTTP Verb | Operation | Query Params | Request Body |
|---|---|---|---|
GET |
Get object / Search objects | q, assignedTo, p, r, f, l | — |
POST |
Add new object | — | JSON or XML |
PUT |
Update object / Add or update child row | — | JSON or XML |
DELETE |
Delete object / Delete child row | — | JSON (child delete only) |
Large Volume Limits
Hosted subscribers using the REST API to create or update records may incur additional hosting fees. When large volumes of data need to be added or updated, please submit a ticket for additional information about current rates and limits.
Security
Authentication Methods
Basic Authentication
Pass Base64-encoded username:password in the Authorization header:
Authorization: Basic [username:password Base64 encoded]Session Token Authentication
Pass the session key obtained from a previous authentication call:
DWAYSessionId: [Session key from previous authentication]Requirements
- SSL encryption (128-bit) required for all traffic
- IP address whitelisting required — contact the Ideagen Operations team
- Authentication required for all resource access
Authentication may return 401 for:
Password Expiration, Change Password on First Login, Too Many Login Attempts, or Inactive Account. Contact your Technical Account Manager for policy details.
Auditing
All transactions that add or modify data are tagged with the originator's username. This information is available on the Object History window for every object and may be used for audit reports.
Resource Paths
Resource paths include subscriber and module information from your Ideagen EHSQ application. A full URL example:
https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-TST-
Base URL — e.g.
https://rest-config.Ideagen.com/RESTConnect -
Version —
/rest/v2 -
Resource —
/subscribers/{subscriber}/modules/{module}
URL Encoding
Query parameters must be percent-encoded. Example: ?q=FirstName%3DJoe%26LastName%3DSmith
Object Identifiers
Object identifiers (e.g. PER 2012-1452, CV 2011-11330) uniquely identify module instances. Spaces must be encoded as %20 in URLs.
Object Identifier vs. Custom Identifiers
Every object contains a system generated unique identifier stored in theH:IDfield. Custom identifiers (often calculated in a character field) may be used through the user interface, but the system identifier must be used in REST queries.
Common Parameters
Path Parameters
| Parameter | Description |
|---|---|
subscriber |
Subscriber code found in Preferences panel of Admin Dashboard |
module |
Module code found on Module Definition panel |
identifier |
Object identifier (e.g. PER 2012-1452) |
Header Parameters
| Parameter | Description |
|---|---|
Accept |
Media type(s) acceptable — application/json or application/xml
|
Content-Type |
Media type of request body — application/json or application/xml
|
Authorization |
Basic authentication credentials |
DWAYSessionId |
Session token for authentication |
If-None-Match |
ETag value for conditional requests |
Module Documentation
Any module can provide its own API documentation. Add /doc to the end of the module path for example:
https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-INC/docThe documentation is accessed from a browser and is built on demand, so it always reflects the module's current definition. The user is prompted for credentials unless the browser already holds a valid session.
Account must have module access
The account logging in must have access to the module and the module must be enabled for API access on the incoming Web Services admin screen.
Documentation Contents
The generated page includes:
- Overview: module name, category, identifier prefix, API enabled status, and the module definition revision
- Authentication: HTTP Basic to session token, or OAuth 2.0 for Interface accounts
- Base URL and conventions: the module's base URL, encoding rules, and the modules it references
- Data types and object schema: JSON formats for each field type, a structure diagram, and a field table for the header and each child grid (JSON key, type, required, read-only)
- Examples and picklist values: sample create and read payloads, and the allowed values for each picklist field
- Endpoints: read, write, attachment, field attachment, and print operations with parameters, curl examples, and response codes
- Postman collection: downloadable collection and environment files specific to the module
The Postman collection and environment are pre-filled with the module's own field names and subscriber code. The environment leaves the account password and Reporting Authority blank, so add them yourself before running the authentication request.
Checking whether a saved copy is stale
The Overview table includes a Module definition revision and last saved date. Compare it with a previously generated page to see whether the module's fields or rules have changed since.
Paths
This section describes each resource path, the HTTP verbs it supports, and the parameters and responses for every operation. Replace values in braces, such as {subscriber}, with your own values (see Common Parameters). Each operation includes examples, and the same pattern applies to every module.
Module Objects
A module object is a single record in a module, such as a person, an incident, or an inspection. These operations create, retrieve, search, update, and delete records. A record is addressed by its system identifier (see Object Identifiers). A search returns matching identifiers, which you then use in a Get Object request.
Get Object
GET /subscribers/{subscriber}/modules/{module}/{identifier}
Retrieve a specific module object by identifier.
Parameters: Path: subscriber, module, identifier | Headers: Accept, Authorization or DWAYSessionId
Responses: 200 Success 404 Not Found 500 Server-side error
Example Request
GET /rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234
Accept: application/json
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Example Response (JSON)
{
"ReportingAuthority": "Ideagen",
"FirstName": "Joe",
"LastName": "Smith",
"Status": "Active"
}
curl --location 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234' \
--header 'Accept: application/json' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
GET https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234
Headers:
Accept: application/json
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Method: GET
URL:https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234
Headers:
-
Accept: application/json -
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header>
<Accept>application/json</Accept>
<Authorization>Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</Authorization>
</soapenv:Header>
<soapenv:Body>
<!-- REST Request: GET /rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234 -->
</soapenv:Body>
</soapenv:Envelope>
Get Objects (Search)
GET /subscribers/{subscriber}/modules/{module}?q={query}
Retrieve object identifiers for multiple objects that match the search criteria exactly (including letter case). Wildcards and partial matches are not allowed. A status code 200 with an empty array indicates a successful search with no matches. Response may include Last-Modified and ETag headers.
Parameters:
- Path: subscriber, module
- Query:
q(required) — XML tags and values separated by&, percent-encoded. Example:q=FirstName%3DJoe%26LastName%3DSmith - Query:
assignedTo(optional) — ME (User), TE (Teams), AL (Alternates), MT (Person+Teams), MA (Person+Teams+Alternates), MM (Person+Alternates) - Query:
p,r(optional) — Page and row for pagination - Query:
f(optional) — Return specific fields, e.g.f=Name,Identifier - Query:
l(optional) — Filter by Last Updated (epoch ms), e.g.l=<1713769200000 - Headers: Accept, Authorization or DWAYSessionId, If-None-Match (optional)
Responses: 200 Success 404 Not Found 500 Server-side error
Example Request
GET /rest/v2/subscribers/ABC1234/modules/EXMP-PER?q=FirstName%3DJoe%26LastName%3DSmith
Accept: application/json
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Example Response (JSON)
[
"PER 2011-1432",
"PER 2012-1243",
"PER 2012-1904"
]
curl --location 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER?q=FirstName%3DJoe%26LastName%3DSmith' \
--header 'Accept: application/json' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
GET https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER?q=FirstName%3DJoe%26LastName%3DSmith
Headers:
Accept: application/json
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Method: GET
URL:https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER?q=FirstName%3DJoe%26LastName%3DSmith
Headers:
-
Accept: application/json -
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header>
<Accept>application/json</Accept>
<Authorization>Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</Authorization>
</soapenv:Header>
<soapenv:Body>
<!-- REST Request: GET /rest/v2/subscribers/ABC1234/modules/EXMP-PER?q=... -->
</soapenv:Body>
</soapenv:Envelope>
Post Object (Create New)
POST /subscribers/{subscriber}/modules/{module}
Add a new object instance. On success, the new object's URL is returned in the response Location header. Include ReportingAuthority and all required fields.
Parameters:
- Path: subscriber, module
- Headers: Content-Type (
application/jsonorapplication/xml), Authorization or DWAYSessionId - Body: JSON or XML
Responses: 200 Success — Location header contains new object URL 404 Not Found 500 Server-side error
Example Request (JSON)
POST /rest/v2/subscribers/ABC1234/modules/EXMP-PER
Content-Type: application/json
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
{
"ReportingAuthority": "Ideagen",
"FirstName": "Joe",
"LastName": "Smith",
"EmployeeId": "ABC1234",
"Manager": {
"ModuleCode": "EXMP-PER",
"Identifier": "PER 2011-2052"
},
"Comments": [
{
"Comment": "Joe is a good worker.",
"By": {
"ModuleCode": "EXMP-PER",
"Identifier": "PER 2011-2052"
}
}
]
}
curl --location 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
--data '{"ReportingAuthority":"Ideagen","FirstName":"Joe","LastName":"Smith","EmployeeId":"ABC1234"}'
POST https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER
Headers:
Content-Type: application/json
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Method: POST
URL:https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER
Headers:
-
Content-Type: application/json -
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header>
<Content-Type>application/json</Content-Type>
<Authorization>Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</Authorization>
</soapenv:Header>
<soapenv:Body>
<!-- REST Request: POST /rest/v2/subscribers/ABC1234/modules/EXMP-PER -->
</soapenv:Body>
</soapenv:Envelope>
Put Object (Update)
PUT /subscribers/{subscriber}/modules/{module}/{identifier}
Update an existing module instance by object identifier.
Parameters:
- Path: subscriber, module, identifier
- Headers: Content-Type (
application/jsonorapplication/xml), Accept, Authorization or DWAYSessionId - Body: JSON or XML
Responses: 200 Success 404 Not Found 500 Server-side error
Example Request (JSON)
PUT /rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202012-0123
Content-Type: application/json
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
{
"Status": "Inactive",
"Manager": {
"ModuleCode": "EXMP-PER",
"Identifier": "PER 2011-0843"
},
"Comments": [
{
"Comment": "Updating Joe's status and manager.",
"By": {
"ModuleCode": "EXMP-PER",
"Identifier": "PER 2011-0843"
}
}
]
}
curl --location --request PUT 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202012-0123' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
--data '{"Status":"Inactive"}'
PUT https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202012-0123
Headers:
Content-Type: application/json
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Method: PUT
URL:https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202012-0123
Headers:
-
Content-Type: application/json -
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header>
<Content-Type>application/json</Content-Type>
<Authorization>Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</Authorization>
</soapenv:Header>
<soapenv:Body>
<!-- REST Request: PUT /rest/v2/subscribers/.../modules/.../identifier -->
</soapenv:Body>
</soapenv:Envelope>
Delete Object
DELETE /subscribers/{subscriber}/modules/{module}/{identifier}
Remove a single module instance by object identifier.
Parameters: Path: subscriber, module, identifier | Headers: Authorization or DWAYSessionId
Responses: 204 No Content (successfully deleted) 404 Not Found 500 Server-side error
Example Request
DELETE /rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202012-0123
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
curl --location --request DELETE 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202012-0123' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
DELETE https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202012-0123
Headers:
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Method: DELETE
URL:https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202012-0123
Headers:
-
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header>
<Authorization>Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</Authorization>
</soapenv:Header>
<soapenv:Body>
<!-- REST Request: DELETE /rest/v2/subscribers/.../modules/.../identifier -->
</soapenv:Body>
</soapenv:Envelope>
Child Level Data
Many modules store repeating data in child levels, such as comments, tasks, or line items. Child rows belong to their parent object, so there is no separate path for a row. Read them with Get Object, then add, update, or delete them with a request to the parent object's path. Rows are identified by Row_Identifier in the request body. See Child-Level Rows for how this works.
Add Child Row
PUT /subscribers/{subscriber}/modules/{module}/{identifier} (Add Child Row)
Add one or more child-level rows to an existing object. Send a JSON body containing the child level structure with the new rows. Do not include a Row_Identifier for a new row, because the system generates it. Existing rows and header fields that are not in the body are not changed.
Parameters: Path: subscriber, module, identifier | Headers: Content-Type (application/json), Authorization or DWAYSessionId | Body: JSON with the new child rows
Responses: 200 Success 400 Validation or business rule failure 404 Not Found 500 Server-side error
Example Request (JSON)
PUT /rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202012-0123
Content-Type: application/json
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
{
"Comments": [
{
"Comment": "Follow-up review completed.",
"By": {
"ModuleCode": "EXMP-PER",
"Identifier": "PER 2011-0843"
}
}
]
}
curl --location --request PUT 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202012-0123' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
--data '{"Comments":[{"Comment":"Follow-up review completed.","By":{"ModuleCode":"EXMP-PER","Identifier":"PER 2011-0843"}}]}'
Update Child Row
PUT /subscribers/{subscriber}/modules/{module}/{identifier} (Update Child Row)
Update an existing child-level row. Send a JSON body containing the child level structure with the Row_Identifier of the row to change and only the fields to update. Fields that are not in the body keep their current values.
Parameters: Path: subscriber, module, identifier | Headers: Content-Type (application/json), Authorization or DWAYSessionId | Body: JSON with Row_Identifier and the fields to update
Responses: 200 Success 400 Validation or business rule failure 404 Not Found 500 Server-side error
Finding the Row_Identifier
TheRow_Identifierof each child row is returned in the response of a Get Object request. Without it, the row is treated as a new row and added instead of updated.
Example Request (JSON)
PUT /rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202012-0123
Content-Type: application/json
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
{
"Comments": [
{
"Row_Identifier": "458297",
"Comment": "Follow-up review completed and approved."
}
]
}
curl --location --request PUT 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202012-0123' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
--data '{"Comments":[{"Row_Identifier":"458297","Comment":"Follow-up review completed and approved."}]}'
Delete Child Row
DELETE /subscribers/{subscriber}/modules/{module}/{identifier} (Delete Child Row)
Remove child-level rows from an object. Send a JSON body containing the child level structure with only the Row_Identifier values to be deleted. Additional values are discarded.
Parameters: Path: subscriber, module, identifier | Headers: Content-Type (application/json), Authorization or DWAYSessionId | Body: JSON with Row_Identifier values to delete
Responses: 204 No Content (child row successfully deleted) 404 Not Found 500 Server-side error
Example Request
DELETE /rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202012-0123
Content-Type: application/json
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
{
"Comments": [
{
"Row_Identifier": "458297"
}
]
}
curl --location --request DELETE 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202012-0123' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
--data '{"Comments":[{"Row_Identifier":"458297"}]}'
Attachments
Module objects can accept and store attachment files (Word, Excel, CSV, JPEG, text, and so on). Attachments are accessed through the files sub-resource of an object. Start with the list request, which returns a link for each attachment. The last part of that link is the attachmentKey used to download, update, or delete that file. The key is based on the file name, so replacing a file with a differently named one returns a new key.
Get Attachments List (Search)
GET /subscribers/{subscriber}/modules/{module}/{identifier}/files
Retrieve a list of attachments associated with an object. Response contains hypermedia links to download each attachment. JSON only (XML not supported).
Parameters: Path: subscriber, module, identifier | Headers: Accept (application/json), Authorization or DWAYSessionId, If-None-Match (optional)
Responses: 200 Success 304 Not Modified 404 Not Found 500 Server-side error
Example Request
GET /rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234/files
Accept: application/json
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Example Response (JSON)
[
{
"fileName": "001c.csv",
"creationDate": "2013-01-21T22:42:31.000 PST",
"excludeFromPrint": "N",
"link": {
"rel": "self",
"type": "application/csv",
"href": "https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234/files/MDAxYy5jc3Y6MjQxMg"
}
}
]
curl --location 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234/files' \
--header 'Accept: application/json' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
Get Attachment (Download)
GET /subscribers/{subscriber}/modules/{module}/{identifier}/files/{attachmentKey}
Download an attachment using the hypermedia URL from the list response.
Parameters: Path: subscriber, module, identifier, attachmentKey | Headers: Accept (application/octet-stream or application/pdf), Authorization or DWAYSessionId, If-None-Match (optional)
Responses: 200 Success — Returns octet-stream 304 Not Modified 404 Not Found 415 Unsupported media type (file could not be converted to PDF) 500 Server-side error
Example Request
GET /rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234/files/MDAxYy5jc3Y6MjQxMg
Accept: application/octet-stream
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Response headers: Content-Disposition,
Content-Type, Content-Length
curl --location 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234/files/MDAxYy5jc3Y6MjQxMg' \
--header 'Accept: application/octet-stream' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
--output attachment.bin
Post Attachment (Upload)
POST /subscribers/{subscriber}/modules/{module}/{identifier}/files
Upload a new attachment using multipart/form-data. Form parameters: file (required), excludePrint (true/false, default false).
Parameters: Path: subscriber, module, identifier | Headers: Content-Type (multipart/form-data), Authorization or DWAYSessionId
Responses: 201 Created — Location header contains new attachment URL 500 Server-side error
Example Request
POST /rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234/files
Content-Type: multipart/form-data
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Form: file=[binary], excludePrint=false
curl --location 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234/files' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
--form 'file=@/path/to/file.pdf' \
--form 'excludePrint=false'
Put Attachment (Update)
PUT /subscribers/{subscriber}/modules/{module}/{identifier}/files/{attachmentKey}
Modify an existing attachment. Requires the Files Modifiable attribute to be enabled for the module's Attachments grid.
Parameters: Path: subscriber, module, identifier, attachmentKey | Headers: Content-Type (multipart/form-data), Authorization or DWAYSessionId | Form: file, excludePrint (optional)
Responses: 200 Success 403 Forbidden (Files Modifiable not enabled) 500 Server-side error
Example Request
PUT /rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234/files/aW1hZ2VfcG9zdF8yLnBuZzoyNTYy
Content-Type: multipart/form-data
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Form: file=[binary], excludePrint=false
curl --location --request PUT 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234/files/aW1hZ2VfcG9zdF8yLnBuZzoyNTYy' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
--form 'file=@/path/to/updated.pdf'
Delete Attachment
DELETE /subscribers/{subscriber}/modules/{module}/{identifier}/files/{attachmentKey}
Delete an attachment using the hypermedia URL from the list response.
Parameters: Path: subscriber, module, identifier, attachmentKey | Headers: Authorization or DWAYSessionId
Responses: 204 No Content (successfully deleted) 404 Not Found 500 Server-side error
Example Request
DELETE /rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234/files/MDAxYy5jc3Y6MjQxMg
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
curl --location --request DELETE 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234/files/MDAxYy5jc3Y6MjQxMg' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
Field Attachments
Some attachments are associated with fields as field level attachments. Field attachments are accessed through the fieldfiles sub-resource of an object. A field attachment belongs to one field, identified by its JSON key (the JSON key column in the module's Module Documentation, not the platform field code). For a field in a child level, it can also belong to one row. Start with the list request, which returns every field attachment on the object across all fields. The last part of each returned link is the attachmentKey used to download, replace, or delete that file. The key is based on the file name, so replacing a file with a differently named one returns a new key.
Get Field Attachments (List)
GET /subscribers/{subscriber}/modules/{module}/{identifier}/fieldfiles
Retrieve a list of every field attachment associated with an object, across all fields. Response contains hypermedia links to download each attachment. JSON only (XML not supported).
Parameters: Path: subscriber, module, identifier | Headers: Accept (application/json), Authorization or DWAYSessionId, If-None-Match (optional)
Responses: 200 Success 304 Not Modified 403 Forbidden 404 Not Found 500 Server-side error
Example Request
GET /rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234/fieldfiles
Accept: application/json
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Example Response (JSON)
[
{
"fileName": "Report.pdf",
"creationDate": "2026-01-31T09:15:00.000 EST",
"excludeFromPrint": "N",
"link": {
"rel": "self",
"type": "application/pdf",
"href": "https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234/fieldfiles/UmVwb3J0LnBkZjoyNDEy"
}
}
]
curl --location 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234/fieldfiles' \
--header 'Accept: application/json' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
Get Field Attachment (Download)
GET /subscribers/{subscriber}/modules/{module}/{identifier}/fieldfiles/{attachmentKey}
Download a field attachment using the hypermedia URL from the list response.
Parameters: Path: subscriber, module, identifier, attachmentKey | Headers: Accept (application/octet-stream), Authorization or DWAYSessionId, If-None-Match (optional)
Responses: 200 Success: Returns the file with its original content type 304 Not Modified 403 Forbidden 404 Not Found 500 Server-side error
Example Request
GET /rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234/fieldfiles/UmVwb3J0LnBkZjoyNDEy
Accept: application/octet-stream
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Response headers: Content-Disposition,
Content-Type, Content-Length
curl --location 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234/fieldfiles/UmVwb3J0LnBkZjoyNDEy' \
--header 'Accept: application/octet-stream' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
--output attachment.bin
Post Field Attachment (Upload)
POST /subscribers/{subscriber}/modules/{module}/{identifier}/fieldfiles
Upload a new attachment to one field using multipart/form-data. Form parameters: file (required), field (required), row (optional, child-level fields only), excludePrint (true/false, default false).
-
field: the JSON key of the field the file attaches to, as shown in the JSON key column of the module's Module Documentation. Do not use the platform field code. -
row: theRow_Identifierof an existing child row to attach the file to. If omitted for a child-level field, a new child row is created for the file.
Parameters: Path: subscriber, module, identifier | Headers: Content-Type (multipart/form-data), Authorization or DWAYSessionId
Responses: 201 Created: Location header contains the new attachment URL. When a child row was created, the response body is that row, including its Row_Identifier 400 No file part in the request 403 Forbidden 404 Record or field not found 408 Upload did not complete, retry the request 500 Server-side error
Example Request (Header Field)
POST /rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234/fieldfiles
Content-Type: multipart/form-data
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Form: file=[binary], excludePrint=false, field=SupportingDocument
Example Request (Existing Child Row)
POST /rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234/fieldfiles
Content-Type: multipart/form-data
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Form: file=[binary], excludePrint=false, field=CommentAttachment, row=458297
curl --location 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234/fieldfiles' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
--form 'file=@/path/to/file.pdf' \
--form 'excludePrint=false' \
--form 'field=SupportingDocument'
To attach to an existing child row, add the row:
--form 'row=458297'
Put Field Attachment (Update)
PUT /subscribers/{subscriber}/modules/{module}/{identifier}/fieldfiles/{attachmentKey}
Replace the file behind an existing field attachment. The request uses the same file and excludePrint form parameters as the upload, with no field or row parameter, because the attachment key already identifies them. If the replacement file has a different name, the attachment gets a new key, which is returned in the Location header. Use the new key from then on.
Parameters: Path: subscriber, module, identifier, attachmentKey | Headers: Content-Type (multipart/form-data), Authorization or DWAYSessionId | Form: file, excludePrint (optional)
Responses: 200 Success: Location header contains the attachment URL 400 No file part in the request 403 Forbidden 404 Not Found 408 Upload did not complete, retry the request 500 Server-side error
Example Request
PUT /rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234/fieldfiles/UmVwb3J0LnBkZjoyNDEy
Content-Type: multipart/form-data
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Form: file=[binary], excludePrint=false
curl --location --request PUT 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234/fieldfiles/UmVwb3J0LnBkZjoyNDEy' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
--form 'file=@/path/to/updated.pdf'
Delete Field Attachment
DELETE /subscribers/{subscriber}/modules/{module}/{identifier}/fieldfiles/{attachmentKey}
Delete a field attachment using the hypermedia URL from the list response.
Parameters: Path: subscriber, module, identifier, attachmentKey | Headers: Authorization or DWAYSessionId
Responses: 204 No Content (successfully deleted) 403 Forbidden 404 Not Found 500 Server-side error
Example Request
DELETE /rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234/fieldfiles/UmVwb3J0LnBkZjoyNDEy
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
curl --location --request DELETE 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PER/PER%202011-1234/fieldfiles/UmVwb3J0LnBkZjoyNDEy' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
Subscriber Resource
Access information about a subscriber. Includes optional person_module and person_object when a Persons module is defined in Preferences under Person and Teams.
GET /subscribers/{subscriber}
Retrieve subscriber preferences, person info, and broadcast messages.
Parameters: Path: subscriber | Headers: Accept (application/json), Authorization or DWAYSessionId
Responses: 200 Success 401 Unauthorized 500 Server-side error
Example Request
GET /rest/v2/subscribers/ABC1234
Accept: application/json
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Example Response (JSON)
{
"preferences": {
"companyCode": "RF",
"areaName": "DWAYDev",
"dateFormat": "YYYY-MM-DD",
"timeZoneCode": "EST",
"companyName": "Rodeo Frog"
},
"person_module": "EXMP-PER",
"person_object": {
"Identifier": "PER 2014-0001",
"PersonName": "Smith, Joe",
"FirstName": "Joe",
"LastName": "Smith"
},
"person": {
"firstName": "Joe",
"lastName": "Smith",
"_id": "dwaydev_quhktt3671_2004000720"
},
"broadcastMessages": []
}
curl --location 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234' \
--header 'Accept: application/json' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
Search Resource
A user's previously saved searches can be accessed and executed from this resource. Results are paginated in blocks of 10 results.
Get Searches (List)
GET /subscribers/{subscriber}/search
Retrieve a list of saved searches available to the authenticated user.
Parameters: Path: subscriber | Headers: Accept (application/json), Authorization or DWAYSessionId
Responses: 200 Success 401 Unauthorized 500 Server-side error
Example Request
GET /rest/v2/subscribers/ABC1234/search
Accept: application/json
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Example Response (JSON)
[
{
"name": "Tasks to complete",
"href": "https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/search/2004000720-1"
},
{
"name": "Tasks to approve",
"href": "https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/search/2004000720-2"
}
]
curl --location 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/search' \
--header 'Accept: application/json' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
GET https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/search
Headers:
Accept: application/json
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Method: GET
URL:https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/search
Headers:
-
Accept: application/json -
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header>
<Accept>application/json</Accept>
<Authorization>Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</Authorization>
</soapenv:Header>
<soapenv:Body>
<!-- REST Request: GET /rest/v2/subscribers/ABC1234/search -->
</soapenv:Body>
</soapenv:Envelope>
Get Search (Execute)
GET /subscribers/{subscriber}/search/{searchId}?page={pageNumber}
Execute a saved search and retrieve results. Results are paginated with 10 results per page.
Parameters: Path: subscriber, searchId | Query: page (optional, integer starting from 0) | Headers: Accept (application/json), Authorization or DWAYSessionId
Responses: 200 Success 404 Not Found 500 Server-side error
Example Request
GET /rest/v2/subscribers/ABC1234/search/2004000720-10?page=1
Accept: application/json
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Example Response (JSON)
{
"totalResults": 2,
"resultsPosition": 0,
"results": [
{
"Identifier": "LP 2013-0009",
"Title": "Review document"
}
]
}
curl --location 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/search/2004000720-10?page=1' \
--header 'Accept: application/json' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
GET https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/search/2004000720-10?page=1
Headers:
Accept: application/json
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Method: GET
URL:https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/search/2004000720-10?page=1
Headers:
-
Accept: application/json -
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header>
<Accept>application/json</Accept>
<Authorization>Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</Authorization>
</soapenv:Header>
<soapenv:Body>
<!-- REST Request: GET /rest/v2/subscribers/ABC1234/search/2004000720-10?page=1 -->
</soapenv:Body>
</soapenv:Envelope>
Print Resource
Users can generate PDF representations of objects using the print resource. For long-running PDF generation, use the async option.
Get Print Codes (List)
GET /subscribers/{subscriber}/modules/{module}/{identifier}/print
Retrieve available print codes (templates) for an object.
Parameters: Path: subscriber, module, identifier | Headers: Accept (application/json), Authorization or DWAYSessionId
Responses: 200 Success 403 Forbidden 404 Not Found 500 Server-side error
Example Request
GET /rest/v2/subscribers/ABC1234/modules/EXMP-PRN/PRNT%202014-0009/print/
Accept: application/json
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Example Response (JSON)
[
{
"isDefault": "Y",
"name": "Default",
"code": "EXMP-PRN-O-2"
}
]
curl --location 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PRN/PRNT%202014-0009/print/' \
--header 'Accept: application/json' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
GET https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PRN/PRNT%202014-0009/print/
Headers:
Accept: application/json
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Method: GET
URL:https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PRN/PRNT%202014-0009/print/
Headers:
-
Accept: application/json -
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header>
<Accept>application/json</Accept>
<Authorization>Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</Authorization>
</soapenv:Header>
<soapenv:Body>
<!-- REST Request: GET /rest/v2/subscribers/ABC1234/modules/EXMP-PRN/PRNT%202014-0009/print/ -->
</soapenv:Body>
</soapenv:Envelope>
Get Print (Synchronous)
GET /subscribers/{subscriber}/modules/{module}/{identifier}/print/{printCode}
Generate and download a PDF document (synchronous operation).
Parameters: Path: subscriber, module, identifier, printCode | Headers: Authorization or DWAYSessionId
Responses: 200 Success — Returns PDF 303 See Other 403 Forbidden 404 Not Found 500 Server-side error
Example Request
GET /rest/v2/subscribers/ABC1234/modules/EXMP-PRN/PRNT%202014-0009/print/EXMP-PRN-O-2
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
curl --location 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PRN/PRNT%202014-0009/print/EXMP-PRN-O-2' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
--output document.pdf
GET https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PRN/PRNT%202014-0009/print/EXMP-PRN-O-2
Headers:
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Select Send and Download to save the PDF.
Method: GET
URL:https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PRN/PRNT%202014-0009/print/EXMP-PRN-O-2
Headers:
-
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header>
<Authorization>Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</Authorization>
</soapenv:Header>
<soapenv:Body>
<!-- REST Request: GET /rest/v2/subscribers/ABC1234/modules/EXMP-PRN/PRNT%202014-0009/print/EXMP-PRN-O-2 -->
</soapenv:Body>
</soapenv:Envelope>
Get Print (Asynchronous)
GET /subscribers/{subscriber}/modules/{module}/{identifier}/print/{printCode}?async=true
Submit an asynchronous print job. Returns a job URL for polling.
Parameters: Path: subscriber, module, identifier, printCode | Query: async=true (required) | Headers: Authorization or DWAYSessionId
Responses: 303 See Other — Job URL in Location header 403 Forbidden 404 Not Found 500 Server-side error
Example Request
GET /rest/v2/subscribers/ABC1234/modules/EXMP-PRN/PRNT%202014-0009/print/EXMP-PRN-O-2?async=true
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Example Response Headers
HTTP/1.1 303 See Other
Location: https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PRN/PRNT%202014-0009/print/job/NDUx...
curl --location 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PRN/PRNT%202014-0009/print/EXMP-PRN-O-2?async=true' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
GET https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PRN/PRNT%202014-0009/print/EXMP-PRN-O-2?async=true
Headers:
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Method: GET
URL:https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PRN/PRNT%202014-0009/print/EXMP-PRN-O-2?async=true
Headers:
-
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header>
<Authorization>Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</Authorization>
</soapenv:Header>
<soapenv:Body>
<!-- REST Request: GET .../print/EXMP-PRN-O-2?async=true -->
</soapenv:Body>
</soapenv:Envelope>
Get Print Job Status
GET /subscribers/{subscriber}/modules/{module}/{identifier}/print/job/{jobKey}
Check the status of an asynchronous print job. Poll until the job is complete.
Parameters: Path: subscriber, module, identifier, jobKey | Headers: Authorization or DWAYSessionId
Responses: 202 Accepted — Still processing 303 See Other — Complete, PDF URL in Location 404 Not Found 410 Gone — Job expired 500 Server-side error
Example Request
GET /rest/v2/subscribers/ABC1234/modules/EXMP-PRN/PRNT%202014-0009/print/job/NDUxMjh8MzR...
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Example Response — In Progress
HTTP/1.1 202 Accepted
Example Response — Complete
HTTP/1.1 303 See Other
Location: https://rest-config.Ideagen.com/RESTConnect/rest/v2/files/pdf/document.pdf
Recommended polling interval: Poll every 2–5 seconds. Jobs expire after 1 hour.
curl --location 'https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PRN/PRNT%202014-0009/print/job/NDUxMjh8MzR...' \
--header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
GET https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PRN/PRNT%202014-0009/print/job/NDUxMjh8MzR...
Headers:
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Method: GET
URL:https://rest-config.Ideagen.com/RESTConnect/rest/v2/subscribers/ABC1234/modules/EXMP-PRN/PRNT%202014-0009/print/job/NDUxMjh8MzR...
Headers:
-
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header>
<Authorization>Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==</Authorization>
</soapenv:Header>
<soapenv:Body>
<!-- REST Request: GET .../print/job/NDUxMjh8MzR... -->
</soapenv:Body>
</soapenv:Envelope>
Data Formats
Field Codes
The platform uses field codes (e.g. FirstName, LastName) to identify data elements. Field codes are case sensitive. Obtain them from a GET response body, from the Fields tab of the module definition in module builder (Name column), or from the module's generated Module Documentation.
Date Fields
In queries — Format: YYYYMMDD (no delimiters). Example: ReportDate=20120302
In request/response bodies — Format: YYYY/MM/DD (with slashes). Example: "ReportDate": "2012/03/02"
International date formats
The date format is independent of the date format set in the Subscriber Area Preferences screen and that used throughout the user interface.
External Object References
Reference an external object using ModuleCode and Identifier:
{ "ModuleCode": "MODULE-CODE", "Identifier": "OBJ ID" }Child-Level Rows
Each child row includes a unique Row_Identifier element:
{ "Row_Identifier": "365438", "Field1": "Value1" }Non-modifiable System Fields
Do not include these fields in POST or PUT requests:
IdentifierInitiatedByInitiatedOn
Embedding New Objects
New external objects can be embedded inside their parents in POST or PUT requests.
Processing order
When embedding new external objects, they are processed innermost leaves first, top to bottom. Plan your request body structure accordingly.