Documents
Index a document.
post/sites/{site-identifier}/documents/{document-identifier}
Request
- Base URL: https://api-dev.superconcepts.com.au/api/v1
- URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/documents/{document-identifier}
- Auth: OAuth 2 (authorization code, authorization URL https://api.supermate.com.au/oauth/v1/authorize, token URL https://api.supermate.com.au/oauth/v1/token, scopes: actuarial_write, audit_read, audit_write, client_access_grant, contactevents_read, contactevents_write, default, documents_read, documents_write, fund:investments_read, fund:members_read, fund:members_write, fund:transactions_read, fund:transactions_write, fund_read, fund_write, security:domains_write, security:policies_write, security:users_invite, site:accounting-notes_write, site:asset-categories_write, site:auditor_write, site:branding_write, site:datafeed-config_write, site:identity_write, site:letters_write, site:policies_write, site:reporting_write, sites_read, superstream:config_write)
Path parameters
site-identifierstring required
The GUID that identifies a site
document-identifierstring guid required
The GUID that identifies a document
Request body
Example request
{
"WorkflowTemplateCode": "Template-Code",
"Links": [
{
"WorkflowInstanceID": 12
}
],
"FinancialYears": [
2021,
2022
],
"AvailableClientViewRoleTypes": [
"AUDITOR",
"ADVISER",
"TRUSTEE"
],
"ExternalDocumentReference": "123e4567-e89b-12d3-a456-426614174000",
"LinkedQueryGUID": [
"123e4567-e89b-12d3-a456-426614174000",
"123e4567-e89b-12d3-a456-426614174111"
],
"LinkedQueryItemAttachmentGUID": [
"bbfd14fa-1289-cb98-d414-3eec88164dec",
"b5a53a2f-7941-58aa-8d14-53b3f6e72dc1"
],
"LinkedTransactionGUID": [
"bbfd14fa-1289-cb98-d414-3eec88164def",
"b5a53a2f-7941-58aa-8d14-53b3f6e72dgh"
],
"LinkedWorkflowInstances": [
12,
13,
14
]
}Response
Success
Changes
No recorded changes to this operation across all 1 revision of this API.