1885 lines
47 KiB
JSON
1885 lines
47 KiB
JSON
{
|
|
"schemaVersion": 2,
|
|
"pathPrefix": "/api/v1",
|
|
"operations": [
|
|
{
|
|
"operationId": "getSetupStatus",
|
|
"method": "GET",
|
|
"path": "/api/v1/setup/status",
|
|
"pages": ["PAGE-23"],
|
|
"api": {
|
|
"module": "setup",
|
|
"export": "getSetupStatus"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "testSetupConnection",
|
|
"method": "POST",
|
|
"path": "/api/v1/setup/test-connection",
|
|
"pages": ["PAGE-23"],
|
|
"api": {
|
|
"module": "setup",
|
|
"export": "testSetupConnection"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "completeSetup",
|
|
"method": "POST",
|
|
"path": "/api/v1/setup/complete",
|
|
"pages": ["PAGE-23"],
|
|
"api": {
|
|
"module": "setup",
|
|
"export": "completeSetup"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getCsrf",
|
|
"method": "GET",
|
|
"path": "/api/v1/auth/csrf",
|
|
"pages": ["PAGE-01"],
|
|
"api": {
|
|
"module": "auth",
|
|
"export": "getCsrf"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "login",
|
|
"method": "POST",
|
|
"path": "/api/v1/auth/login",
|
|
"pages": ["PAGE-01"],
|
|
"api": {
|
|
"module": "auth",
|
|
"export": "login"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getSession",
|
|
"method": "GET",
|
|
"path": "/api/v1/auth/session",
|
|
"pages": ["PAGE-01", "PAGE-02", "PAGE-03"],
|
|
"api": {
|
|
"module": "auth",
|
|
"export": "getSession"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getRoles",
|
|
"method": "GET",
|
|
"path": "/api/v1/auth/roles",
|
|
"pages": ["PAGE-02"],
|
|
"api": {
|
|
"module": "auth",
|
|
"export": "getRoles"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "selectRole",
|
|
"method": "POST",
|
|
"path": "/api/v1/auth/select-role",
|
|
"pages": ["PAGE-02", "PAGE-03"],
|
|
"api": {
|
|
"module": "auth",
|
|
"export": "selectRole"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getProfile",
|
|
"method": "GET",
|
|
"path": "/api/v1/auth/profile",
|
|
"pages": ["PAGE-03"],
|
|
"api": {
|
|
"module": "auth",
|
|
"export": "getProfile"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "changePassword",
|
|
"method": "PATCH",
|
|
"path": "/api/v1/auth/password",
|
|
"pages": ["PAGE-03"],
|
|
"api": {
|
|
"module": "auth",
|
|
"export": "changePassword"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "listSessions",
|
|
"method": "GET",
|
|
"path": "/api/v1/auth/sessions",
|
|
"pages": ["PAGE-03"],
|
|
"api": {
|
|
"module": "auth",
|
|
"export": "listSessions"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "deleteSession",
|
|
"method": "DELETE",
|
|
"path": "/api/v1/auth/sessions/{sessionId}",
|
|
"pages": ["PAGE-03"],
|
|
"api": {
|
|
"module": "auth",
|
|
"export": "deleteSession"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "deleteAllSessions",
|
|
"method": "DELETE",
|
|
"path": "/api/v1/auth/sessions",
|
|
"pages": ["PAGE-03"],
|
|
"api": {
|
|
"module": "auth",
|
|
"export": "deleteAllSessions"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "logout",
|
|
"method": "POST",
|
|
"path": "/api/v1/auth/logout",
|
|
"pages": ["PAGE-02", "PAGE-03"],
|
|
"api": {
|
|
"module": "auth",
|
|
"export": "logout"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getProjectWorkbench",
|
|
"method": "GET",
|
|
"path": "/api/v1/workbenches/project",
|
|
"pages": ["PAGE-04"],
|
|
"api": {
|
|
"module": "workbench",
|
|
"export": "getWorkbench",
|
|
"args": ["project"]
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getFinanceWorkbench",
|
|
"method": "GET",
|
|
"path": "/api/v1/workbenches/finance",
|
|
"pages": ["PAGE-05"],
|
|
"api": {
|
|
"module": "workbench",
|
|
"export": "getWorkbench",
|
|
"args": ["finance"]
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getArchiveWorkbench",
|
|
"method": "GET",
|
|
"path": "/api/v1/workbenches/archive",
|
|
"pages": ["PAGE-06"],
|
|
"api": {
|
|
"module": "workbench",
|
|
"export": "getWorkbench",
|
|
"args": ["archive"]
|
|
}
|
|
},
|
|
{
|
|
"operationId": "listProjects",
|
|
"method": "GET",
|
|
"path": "/api/v1/projects",
|
|
"pages": ["PAGE-07"],
|
|
"api": {
|
|
"module": "project",
|
|
"export": "getProjects"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getProjectReferences",
|
|
"method": "GET",
|
|
"path": "/api/v1/projects/references",
|
|
"pages": ["PAGE-07", "PAGE-08"],
|
|
"api": {
|
|
"module": "project",
|
|
"export": "getProjectReferences"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "createProject",
|
|
"method": "POST",
|
|
"path": "/api/v1/projects",
|
|
"pages": ["PAGE-07"],
|
|
"api": {
|
|
"module": "project",
|
|
"export": "createProject"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "createProjectImport",
|
|
"method": "POST",
|
|
"path": "/api/v1/projects/imports",
|
|
"pages": ["PAGE-07"],
|
|
"api": {
|
|
"module": "project",
|
|
"export": "createProjectImport"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getProjectImport",
|
|
"method": "GET",
|
|
"path": "/api/v1/projects/imports/{publicId}",
|
|
"pages": ["PAGE-07"],
|
|
"api": {
|
|
"module": "project",
|
|
"export": "getProjectImport"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "confirmProjectImport",
|
|
"method": "POST",
|
|
"path": "/api/v1/projects/imports/{publicId}/confirm",
|
|
"pages": ["PAGE-07"],
|
|
"api": {
|
|
"module": "project",
|
|
"export": "confirmProjectImport"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "exportProjects",
|
|
"method": "POST",
|
|
"path": "/api/v1/projects/exports",
|
|
"pages": ["PAGE-07"],
|
|
"api": {
|
|
"module": "project",
|
|
"export": "exportProjects"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getProject",
|
|
"method": "GET",
|
|
"path": "/api/v1/projects/{publicId}",
|
|
"pages": ["PAGE-08"],
|
|
"api": {
|
|
"module": "project",
|
|
"export": "getProject"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "updateProject",
|
|
"method": "PATCH",
|
|
"path": "/api/v1/projects/{publicId}",
|
|
"pages": ["PAGE-07", "PAGE-08"],
|
|
"api": {
|
|
"module": "project",
|
|
"export": "updateProject"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "completeProjectFinance",
|
|
"method": "POST",
|
|
"path": "/api/v1/projects/{publicId}/finance-complete",
|
|
"pages": ["PAGE-08", "PAGE-17"],
|
|
"api": {
|
|
"module": "project",
|
|
"export": "completeProjectFinance"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getProjectForms",
|
|
"method": "GET",
|
|
"path": "/api/v1/projects/{projectPublicId}/forms",
|
|
"pages": ["PAGE-08"],
|
|
"api": {
|
|
"module": "project",
|
|
"export": "getProjectSubresource",
|
|
"args": ["PUBLIC_ID", "forms"]
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getProjectContracts",
|
|
"method": "GET",
|
|
"path": "/api/v1/projects/{projectPublicId}/contracts",
|
|
"pages": ["PAGE-08"],
|
|
"api": {
|
|
"module": "project",
|
|
"export": "getProjectSubresource",
|
|
"args": ["PUBLIC_ID", "contracts"]
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getProjectReceipts",
|
|
"method": "GET",
|
|
"path": "/api/v1/projects/{projectPublicId}/receipts",
|
|
"pages": ["PAGE-08"],
|
|
"api": {
|
|
"module": "project",
|
|
"export": "getProjectSubresource",
|
|
"args": ["PUBLIC_ID", "receipts"]
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getProjectInvoices",
|
|
"method": "GET",
|
|
"path": "/api/v1/projects/{projectPublicId}/invoices",
|
|
"pages": ["PAGE-08"],
|
|
"api": {
|
|
"module": "project",
|
|
"export": "getProjectSubresource",
|
|
"args": ["PUBLIC_ID", "invoices"]
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getProjectPayments",
|
|
"method": "GET",
|
|
"path": "/api/v1/projects/{projectPublicId}/payments",
|
|
"pages": ["PAGE-08"],
|
|
"api": {
|
|
"module": "project",
|
|
"export": "getProjectSubresource",
|
|
"args": ["PUBLIC_ID", "payments"]
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getProjectProgress",
|
|
"method": "GET",
|
|
"path": "/api/v1/projects/{projectPublicId}/progress",
|
|
"pages": ["PAGE-08"],
|
|
"api": {
|
|
"module": "project",
|
|
"export": "getProjectSubresource",
|
|
"args": ["PUBLIC_ID", "progress"]
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getProjectPeople",
|
|
"method": "GET",
|
|
"path": "/api/v1/projects/{projectPublicId}/people",
|
|
"pages": ["PAGE-08"],
|
|
"api": {
|
|
"module": "project",
|
|
"export": "getProjectSubresource",
|
|
"args": ["PUBLIC_ID", "people"]
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getProjectAccounting",
|
|
"method": "GET",
|
|
"path": "/api/v1/projects/{projectPublicId}/accounting",
|
|
"pages": ["PAGE-08"],
|
|
"api": {
|
|
"module": "project",
|
|
"export": "getProjectSubresource",
|
|
"args": ["PUBLIC_ID", "accounting"]
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getProjectArchives",
|
|
"method": "GET",
|
|
"path": "/api/v1/projects/{projectPublicId}/archives",
|
|
"pages": ["PAGE-08"],
|
|
"api": {
|
|
"module": "project",
|
|
"export": "getProjectSubresource",
|
|
"args": ["PUBLIC_ID", "archives"]
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getProjectTimeline",
|
|
"method": "GET",
|
|
"path": "/api/v1/projects/{projectPublicId}/timeline",
|
|
"pages": ["PAGE-08"],
|
|
"api": {
|
|
"module": "project",
|
|
"export": "getProjectSubresource",
|
|
"args": ["PUBLIC_ID", "timeline"]
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getProjectRiskFlags",
|
|
"method": "GET",
|
|
"path": "/api/v1/projects/{projectPublicId}/risk-flags",
|
|
"pages": ["PAGE-08"],
|
|
"api": {
|
|
"module": "project",
|
|
"export": "getProjectSubresource",
|
|
"args": ["PUBLIC_ID", "risk-flags"]
|
|
}
|
|
},
|
|
{
|
|
"operationId": "createProjectRiskFlag",
|
|
"method": "POST",
|
|
"path": "/api/v1/projects/{publicId}/risk-flags",
|
|
"pages": ["PAGE-08"],
|
|
"api": {
|
|
"module": "project",
|
|
"export": "createProjectRiskFlag"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "resolveProjectRiskFlag",
|
|
"method": "POST",
|
|
"path": "/api/v1/projects/{publicId}/risk-flags/{riskPublicId}/resolve",
|
|
"pages": ["PAGE-08"],
|
|
"api": {
|
|
"module": "project",
|
|
"export": "resolveProjectRiskFlag"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "listTemplates",
|
|
"method": "GET",
|
|
"path": "/api/v1/source/templates",
|
|
"pages": ["PAGE-09", "PAGE-10"],
|
|
"api": {
|
|
"module": "source",
|
|
"export": "getSourceTemplates"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getSourceTemplate",
|
|
"method": "GET",
|
|
"path": "/api/v1/source/templates/{formType}/versions/{version}",
|
|
"pages": ["PAGE-09", "PAGE-10"],
|
|
"api": {
|
|
"module": "source",
|
|
"export": "getSourceTemplate"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getSourceReferences",
|
|
"method": "GET",
|
|
"path": "/api/v1/source/references",
|
|
"pages": ["PAGE-10", "PAGE-11"],
|
|
"api": {
|
|
"module": "source",
|
|
"export": "getSourceReferences"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "listSourceForms",
|
|
"method": "GET",
|
|
"path": "/api/v1/source/forms",
|
|
"pages": ["PAGE-09"],
|
|
"api": {
|
|
"module": "source",
|
|
"export": "getSourceForms"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getSourceForm",
|
|
"method": "GET",
|
|
"path": "/api/v1/source/forms/{publicId}",
|
|
"pages": ["PAGE-10"],
|
|
"api": {
|
|
"module": "source",
|
|
"export": "getSourceForm"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "createSourceForm",
|
|
"method": "POST",
|
|
"path": "/api/v1/source/forms",
|
|
"pages": ["PAGE-10"],
|
|
"api": {
|
|
"module": "source",
|
|
"export": "createSourceForm"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "updateSourceForm",
|
|
"method": "PATCH",
|
|
"path": "/api/v1/source/forms/{publicId}",
|
|
"pages": ["PAGE-10"],
|
|
"api": {
|
|
"module": "source",
|
|
"export": "updateSourceForm"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "validateSourceForm",
|
|
"method": "POST",
|
|
"path": "/api/v1/source/forms/{publicId}/validate",
|
|
"pages": ["PAGE-09", "PAGE-10"],
|
|
"api": {
|
|
"module": "source",
|
|
"export": "validateSourceForm"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "submitSourceForm",
|
|
"method": "POST",
|
|
"path": "/api/v1/source/forms/{publicId}/submit",
|
|
"pages": ["PAGE-10"],
|
|
"api": {
|
|
"module": "source",
|
|
"export": "submitSourceForm"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "withdrawSourceForm",
|
|
"method": "POST",
|
|
"path": "/api/v1/source/forms/{publicId}/withdraw",
|
|
"pages": ["PAGE-10", "PAGE-11"],
|
|
"api": {
|
|
"module": "source",
|
|
"export": "withdrawSourceForm"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "voidSourceForm",
|
|
"method": "POST",
|
|
"path": "/api/v1/source/forms/{publicId}/void",
|
|
"pages": ["PAGE-10", "PAGE-11"],
|
|
"api": {
|
|
"module": "source",
|
|
"export": "voidSourceForm"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "createSourceImport",
|
|
"method": "POST",
|
|
"path": "/api/v1/source/imports",
|
|
"pages": ["PAGE-10"],
|
|
"api": {
|
|
"module": "source",
|
|
"export": "createSourceImport"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getSourceImport",
|
|
"method": "GET",
|
|
"path": "/api/v1/source/imports/{publicId}",
|
|
"pages": ["PAGE-10"],
|
|
"api": {
|
|
"module": "source",
|
|
"export": "getSourceImport"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "confirmSourceImport",
|
|
"method": "POST",
|
|
"path": "/api/v1/source/imports/{publicId}/confirm",
|
|
"pages": ["PAGE-10"],
|
|
"api": {
|
|
"module": "source",
|
|
"export": "confirmSourceImport"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "uploadBusinessFile",
|
|
"method": "POST",
|
|
"path": "/api/v1/files",
|
|
"pages": ["PAGE-07", "PAGE-10", "PAGE-15"],
|
|
"requestType": "multipart",
|
|
"api": {
|
|
"module": "source",
|
|
"export": "uploadBusinessFile"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "listWorkflowTasks",
|
|
"method": "GET",
|
|
"path": "/api/v1/workflow/tasks",
|
|
"pages": ["PAGE-11"],
|
|
"api": {
|
|
"module": "source",
|
|
"export": "getWorkflowTasks"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getWorkflowTask",
|
|
"method": "GET",
|
|
"path": "/api/v1/workflow/tasks/{publicId}",
|
|
"pages": ["PAGE-11"],
|
|
"api": {
|
|
"module": "source",
|
|
"export": "getWorkflowTask"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "approveWorkflowTask",
|
|
"method": "POST",
|
|
"path": "/api/v1/workflow/tasks/{publicId}/approve",
|
|
"pages": ["PAGE-11"],
|
|
"api": {
|
|
"module": "source",
|
|
"export": "actOnWorkflowTask",
|
|
"args": ["PUBLIC_ID", "approve"]
|
|
}
|
|
},
|
|
{
|
|
"operationId": "returnWorkflowTask",
|
|
"method": "POST",
|
|
"path": "/api/v1/workflow/tasks/{publicId}/return",
|
|
"pages": ["PAGE-11"],
|
|
"api": {
|
|
"module": "source",
|
|
"export": "actOnWorkflowTask",
|
|
"args": ["PUBLIC_ID", "return"]
|
|
}
|
|
},
|
|
{
|
|
"operationId": "rejectWorkflowTask",
|
|
"method": "POST",
|
|
"path": "/api/v1/workflow/tasks/{publicId}/reject",
|
|
"pages": ["PAGE-11"],
|
|
"api": {
|
|
"module": "source",
|
|
"export": "actOnWorkflowTask",
|
|
"args": ["PUBLIC_ID", "reject"]
|
|
}
|
|
},
|
|
{
|
|
"operationId": "withdrawWorkflowInstance",
|
|
"method": "POST",
|
|
"path": "/api/v1/workflow/instances/{instancePublicId}/withdraw",
|
|
"pages": ["PAGE-11"],
|
|
"api": {
|
|
"module": "source",
|
|
"export": "withdrawWorkflowInstance"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "voidWorkflowInstance",
|
|
"method": "POST",
|
|
"path": "/api/v1/workflow/instances/{instancePublicId}/void",
|
|
"pages": ["PAGE-11"],
|
|
"api": {
|
|
"module": "source",
|
|
"export": "voidWorkflowInstance"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "listMasterData",
|
|
"method": "GET",
|
|
"path": "/api/v1/masterdata/{resource}",
|
|
"pages": ["PAGE-12"],
|
|
"api": {
|
|
"module": "masterdata",
|
|
"export": "getMasterDataPage"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getMasterDataDetail",
|
|
"method": "GET",
|
|
"path": "/api/v1/masterdata/{resource}/{publicId}",
|
|
"pages": ["PAGE-12"],
|
|
"api": {
|
|
"module": "masterdata",
|
|
"export": "getMasterDataDetail"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "listMasterDataVersions",
|
|
"method": "GET",
|
|
"path": "/api/v1/masterdata/{resource}/{publicId}/versions",
|
|
"pages": ["PAGE-12"],
|
|
"api": {
|
|
"module": "masterdata",
|
|
"export": "getMasterDataVersions"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "listLegacyIdentifiers",
|
|
"method": "GET",
|
|
"path": "/api/v1/masterdata/{resource}/{publicId}/legacy-identifiers",
|
|
"pages": ["PAGE-12"],
|
|
"api": {
|
|
"module": "masterdata",
|
|
"export": "getLegacyIdentifiers"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "createLegacyIdentifier",
|
|
"method": "POST",
|
|
"path": "/api/v1/masterdata/{resource}/{publicId}/legacy-identifiers",
|
|
"pages": ["PAGE-12"],
|
|
"api": {
|
|
"module": "masterdata",
|
|
"export": "createLegacyIdentifier"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "resolveLegacyIdentifier",
|
|
"method": "GET",
|
|
"path": "/api/v1/masterdata/{resource}/legacy-identifiers/resolve",
|
|
"pages": ["PAGE-10", "PAGE-12"],
|
|
"api": {
|
|
"module": "masterdata",
|
|
"export": "resolveLegacyIdentifier"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "disableLegacyIdentifier",
|
|
"method": "POST",
|
|
"path": "/api/v1/masterdata/{resource}/{publicId}/legacy-identifiers/{mappingPublicId}/disable",
|
|
"pages": ["PAGE-12"],
|
|
"api": {
|
|
"module": "masterdata",
|
|
"export": "disableLegacyIdentifier"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getMasterDataReferences",
|
|
"method": "GET",
|
|
"path": "/api/v1/masterdata/references",
|
|
"pages": ["PAGE-12", "PAGE-16"],
|
|
"api": {
|
|
"module": "masterdata",
|
|
"export": "getMasterDataReferences"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "createMasterData",
|
|
"method": "POST",
|
|
"path": "/api/v1/masterdata/{resource}",
|
|
"pages": ["PAGE-12"],
|
|
"api": {
|
|
"module": "masterdata",
|
|
"export": "createMasterData"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "updateMasterData",
|
|
"method": "PATCH",
|
|
"path": "/api/v1/masterdata/{resource}/{publicId}",
|
|
"pages": ["PAGE-12"],
|
|
"api": {
|
|
"module": "masterdata",
|
|
"export": "updateMasterData"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "submitMasterData",
|
|
"method": "POST",
|
|
"path": "/api/v1/masterdata/{resource}/{publicId}/submit",
|
|
"pages": ["PAGE-12"],
|
|
"api": {
|
|
"module": "masterdata",
|
|
"export": "submitMasterData"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "reviewMasterData",
|
|
"method": "POST",
|
|
"path": "/api/v1/masterdata/{resource}/{publicId}/review",
|
|
"pages": ["PAGE-12"],
|
|
"api": {
|
|
"module": "masterdata",
|
|
"export": "reviewMasterData"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "disableMasterData",
|
|
"method": "POST",
|
|
"path": "/api/v1/masterdata/{resource}/{publicId}/disable",
|
|
"pages": ["PAGE-12"],
|
|
"api": {
|
|
"module": "masterdata",
|
|
"export": "disableMasterData"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "listContractCosts",
|
|
"method": "GET",
|
|
"path": "/api/v1/contract-costs/contracts",
|
|
"pages": ["PAGE-13"],
|
|
"api": {
|
|
"module": "contract-cost",
|
|
"export": "getContractCostPage"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getContractCostReferences",
|
|
"method": "GET",
|
|
"path": "/api/v1/contract-costs/references",
|
|
"pages": ["PAGE-13"],
|
|
"api": {
|
|
"module": "contract-cost",
|
|
"export": "getContractCostReferences"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getContractCost",
|
|
"method": "GET",
|
|
"path": "/api/v1/contract-costs/contracts/{publicId}",
|
|
"pages": ["PAGE-13"],
|
|
"api": {
|
|
"module": "contract-cost",
|
|
"export": "getContractCostDetail"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "createContractChange",
|
|
"method": "POST",
|
|
"path": "/api/v1/contract-costs/contracts/{contractId}/changes",
|
|
"pages": ["PAGE-13"],
|
|
"api": {
|
|
"module": "contract-cost",
|
|
"export": "createContractChange"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "voidContractChange",
|
|
"method": "POST",
|
|
"path": "/api/v1/contract-costs/changes/{changeId}/void",
|
|
"pages": ["PAGE-13"],
|
|
"api": {
|
|
"module": "contract-cost",
|
|
"export": "voidContractChange"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "createContractSettlement",
|
|
"method": "POST",
|
|
"path": "/api/v1/contract-costs/contracts/{contractId}/settlements",
|
|
"pages": ["PAGE-13"],
|
|
"api": {
|
|
"module": "contract-cost",
|
|
"export": "createContractSettlement"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "voidContractSettlement",
|
|
"method": "POST",
|
|
"path": "/api/v1/contract-costs/settlements/{settlementId}/void",
|
|
"pages": ["PAGE-13"],
|
|
"api": {
|
|
"module": "contract-cost",
|
|
"export": "voidContractSettlement"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "createPayable",
|
|
"method": "POST",
|
|
"path": "/api/v1/contract-costs/contracts/{contractId}/payables",
|
|
"pages": ["PAGE-13"],
|
|
"api": {
|
|
"module": "contract-cost",
|
|
"export": "createContractPayable"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "confirmPayable",
|
|
"method": "POST",
|
|
"path": "/api/v1/contract-costs/payables/{payableId}/confirm",
|
|
"pages": ["PAGE-13"],
|
|
"api": {
|
|
"module": "contract-cost",
|
|
"export": "confirmContractPayable"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "voidPayable",
|
|
"method": "POST",
|
|
"path": "/api/v1/contract-costs/payables/{payableId}/void",
|
|
"pages": ["PAGE-13"],
|
|
"api": {
|
|
"module": "contract-cost",
|
|
"export": "voidContractPayable"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "exportContractCosts",
|
|
"method": "GET",
|
|
"path": "/api/v1/contract-costs/contracts/export",
|
|
"pages": ["PAGE-13"],
|
|
"responseType": "blob",
|
|
"api": {
|
|
"module": "contract-cost",
|
|
"export": "exportContractCostCsv"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getReceivableReferences",
|
|
"method": "GET",
|
|
"path": "/api/v1/receivables/references",
|
|
"pages": ["PAGE-14"],
|
|
"api": {
|
|
"module": "receivable",
|
|
"export": "getReceivableReferences"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "listReceivables",
|
|
"method": "GET",
|
|
"path": "/api/v1/receivables",
|
|
"pages": ["PAGE-14"],
|
|
"api": {
|
|
"module": "receivable",
|
|
"export": "getReceivables"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "listReceipts",
|
|
"method": "GET",
|
|
"path": "/api/v1/receipts",
|
|
"pages": ["PAGE-14"],
|
|
"api": {
|
|
"module": "receivable",
|
|
"export": "getReceipts"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getReceipt",
|
|
"method": "GET",
|
|
"path": "/api/v1/receipts/{publicId}",
|
|
"pages": ["PAGE-14"],
|
|
"api": {
|
|
"module": "receivable",
|
|
"export": "getReceipt"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "createReceipt",
|
|
"method": "POST",
|
|
"path": "/api/v1/receipts",
|
|
"pages": ["PAGE-14"],
|
|
"api": {
|
|
"module": "receivable",
|
|
"export": "createReceipt"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "updateReceipt",
|
|
"method": "PATCH",
|
|
"path": "/api/v1/receipts/{publicId}",
|
|
"pages": ["PAGE-14"],
|
|
"api": {
|
|
"module": "receivable",
|
|
"export": "updateReceipt"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "confirmReceipt",
|
|
"method": "POST",
|
|
"path": "/api/v1/receipts/{publicId}/confirm",
|
|
"pages": ["PAGE-14"],
|
|
"api": {
|
|
"module": "receivable",
|
|
"export": "confirmReceipt"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "allocateReceipt",
|
|
"method": "POST",
|
|
"path": "/api/v1/receipts/{publicId}/allocations",
|
|
"pages": ["PAGE-14"],
|
|
"api": {
|
|
"module": "receivable",
|
|
"export": "allocateReceipt"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "voidReceipt",
|
|
"method": "POST",
|
|
"path": "/api/v1/receipts/{publicId}/void",
|
|
"pages": ["PAGE-14"],
|
|
"api": {
|
|
"module": "receivable",
|
|
"export": "voidReceipt"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "exportReceipts",
|
|
"method": "GET",
|
|
"path": "/api/v1/receipts/export",
|
|
"pages": ["PAGE-14"],
|
|
"responseType": "blob",
|
|
"api": {
|
|
"module": "receivable",
|
|
"export": "exportReceipts"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "listInvoices",
|
|
"method": "GET",
|
|
"path": "/api/v1/invoices",
|
|
"pages": ["PAGE-14"],
|
|
"api": {
|
|
"module": "receivable",
|
|
"export": "getInvoices"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getInvoice",
|
|
"method": "GET",
|
|
"path": "/api/v1/invoices/{publicId}",
|
|
"pages": ["PAGE-14"],
|
|
"api": {
|
|
"module": "receivable",
|
|
"export": "getInvoice"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "createInvoice",
|
|
"method": "POST",
|
|
"path": "/api/v1/invoices",
|
|
"pages": ["PAGE-14"],
|
|
"api": {
|
|
"module": "receivable",
|
|
"export": "createInvoice"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "updateInvoice",
|
|
"method": "PATCH",
|
|
"path": "/api/v1/invoices/{publicId}",
|
|
"pages": ["PAGE-14"],
|
|
"api": {
|
|
"module": "receivable",
|
|
"export": "updateInvoice"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "submitInvoice",
|
|
"method": "POST",
|
|
"path": "/api/v1/invoices/{publicId}/submit",
|
|
"pages": ["PAGE-14"],
|
|
"api": {
|
|
"module": "receivable",
|
|
"export": "submitInvoice"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "reviewInvoice",
|
|
"method": "POST",
|
|
"path": "/api/v1/invoices/{publicId}/review",
|
|
"pages": ["PAGE-14"],
|
|
"api": {
|
|
"module": "receivable",
|
|
"export": "reviewInvoice"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "recordInvoiceResult",
|
|
"method": "POST",
|
|
"path": "/api/v1/invoices/{publicId}/record-result",
|
|
"pages": ["PAGE-14"],
|
|
"api": {
|
|
"module": "receivable",
|
|
"export": "recordInvoiceResult"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "voidInvoice",
|
|
"method": "POST",
|
|
"path": "/api/v1/invoices/{publicId}/void",
|
|
"pages": ["PAGE-14"],
|
|
"api": {
|
|
"module": "receivable",
|
|
"export": "voidInvoice"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "redLetterInvoice",
|
|
"method": "POST",
|
|
"path": "/api/v1/invoices/{publicId}/red-letter",
|
|
"pages": ["PAGE-14"],
|
|
"api": {
|
|
"module": "receivable",
|
|
"export": "redLetterInvoice"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "exportInvoices",
|
|
"method": "GET",
|
|
"path": "/api/v1/invoices/export",
|
|
"pages": ["PAGE-14"],
|
|
"responseType": "blob",
|
|
"api": {
|
|
"module": "receivable",
|
|
"export": "exportInvoices"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getPaymentReferences",
|
|
"method": "GET",
|
|
"path": "/api/v1/payments/references",
|
|
"pages": ["PAGE-15"],
|
|
"api": {
|
|
"module": "payment",
|
|
"export": "getPaymentReferences"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "listFundLedger",
|
|
"method": "GET",
|
|
"path": "/api/v1/funds/ledger",
|
|
"pages": ["PAGE-15"],
|
|
"api": {
|
|
"module": "payment",
|
|
"export": "getFundLedger"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "listPayments",
|
|
"method": "GET",
|
|
"path": "/api/v1/payments",
|
|
"pages": ["PAGE-15"],
|
|
"api": {
|
|
"module": "payment",
|
|
"export": "getPayments"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getPayment",
|
|
"method": "GET",
|
|
"path": "/api/v1/payments/{publicId}",
|
|
"pages": ["PAGE-15"],
|
|
"api": {
|
|
"module": "payment",
|
|
"export": "getPayment"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getPaymentChecks",
|
|
"method": "GET",
|
|
"path": "/api/v1/payments/{publicId}/checks",
|
|
"pages": ["PAGE-15"],
|
|
"api": {
|
|
"module": "payment",
|
|
"export": "getPaymentChecks"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "createPayment",
|
|
"method": "POST",
|
|
"path": "/api/v1/payments",
|
|
"pages": ["PAGE-15"],
|
|
"api": {
|
|
"module": "payment",
|
|
"export": "createPayment"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "updatePayment",
|
|
"method": "PATCH",
|
|
"path": "/api/v1/payments/{publicId}",
|
|
"pages": ["PAGE-15"],
|
|
"api": {
|
|
"module": "payment",
|
|
"export": "updatePayment"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "submitPayment",
|
|
"method": "POST",
|
|
"path": "/api/v1/payments/{publicId}/submit",
|
|
"pages": ["PAGE-15"],
|
|
"api": {
|
|
"module": "payment",
|
|
"export": "submitPayment"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "approvePayment",
|
|
"method": "POST",
|
|
"path": "/api/v1/payments/{publicId}/approve",
|
|
"pages": ["PAGE-15"],
|
|
"api": {
|
|
"module": "payment",
|
|
"export": "approvePayment"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "returnPayment",
|
|
"method": "POST",
|
|
"path": "/api/v1/payments/{publicId}/return",
|
|
"pages": ["PAGE-15"],
|
|
"api": {
|
|
"module": "payment",
|
|
"export": "returnPayment"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "reviewPaymentAttachmentException",
|
|
"method": "POST",
|
|
"path": "/api/v1/payments/{publicId}/attachment-exceptions/{exceptionPublicId}/review",
|
|
"pages": ["PAGE-15"],
|
|
"api": {
|
|
"module": "payment",
|
|
"export": "reviewPaymentAttachmentException"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "requestPaymentControlException",
|
|
"method": "POST",
|
|
"path": "/api/v1/payments/{publicId}/control-exceptions",
|
|
"pages": ["PAGE-15"],
|
|
"api": {
|
|
"module": "payment",
|
|
"export": "requestPaymentControlException"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "reviewPaymentControlException",
|
|
"method": "POST",
|
|
"path": "/api/v1/payments/{publicId}/control-exceptions/{exceptionPublicId}/review",
|
|
"pages": ["PAGE-15"],
|
|
"api": {
|
|
"module": "payment",
|
|
"export": "reviewPaymentControlException"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "voidPayment",
|
|
"method": "POST",
|
|
"path": "/api/v1/payments/{publicId}/void",
|
|
"pages": ["PAGE-15"],
|
|
"api": {
|
|
"module": "payment",
|
|
"export": "voidPayment"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "recordPaymentResult",
|
|
"method": "POST",
|
|
"path": "/api/v1/payments/{publicId}/confirm-offline-result",
|
|
"pages": ["PAGE-15"],
|
|
"api": {
|
|
"module": "payment",
|
|
"export": "confirmOfflinePaymentResult"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "recordPaymentFailure",
|
|
"method": "POST",
|
|
"path": "/api/v1/payments/{publicId}/record-failure",
|
|
"pages": ["PAGE-15"],
|
|
"api": {
|
|
"module": "payment",
|
|
"export": "recordPaymentFailure"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "recordPaymentRefund",
|
|
"method": "POST",
|
|
"path": "/api/v1/payments/{publicId}/record-refund",
|
|
"pages": ["PAGE-15"],
|
|
"api": {
|
|
"module": "payment",
|
|
"export": "recordPaymentRefund"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "verifyPaymentResult",
|
|
"method": "POST",
|
|
"path": "/api/v1/payments/{publicId}/verify-result",
|
|
"pages": ["PAGE-15"],
|
|
"api": {
|
|
"module": "payment",
|
|
"export": "verifyPaymentResult"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "returnPaymentResult",
|
|
"method": "POST",
|
|
"path": "/api/v1/payments/{publicId}/return-result",
|
|
"pages": ["PAGE-15"],
|
|
"api": {
|
|
"module": "payment",
|
|
"export": "returnPaymentResult"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "createRepayment",
|
|
"method": "POST",
|
|
"path": "/api/v1/payments/{publicId}/create-repayment",
|
|
"pages": ["PAGE-15"],
|
|
"api": {
|
|
"module": "payment",
|
|
"export": "createRepayment"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "exportPayments",
|
|
"method": "POST",
|
|
"path": "/api/v1/payments/exports",
|
|
"pages": ["PAGE-15"],
|
|
"responseType": "blob",
|
|
"api": {
|
|
"module": "payment",
|
|
"export": "exportPayments"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "listAccountingAccounts",
|
|
"method": "GET",
|
|
"path": "/api/v1/accounting/accounts",
|
|
"pages": ["PAGE-16"],
|
|
"api": {
|
|
"module": "accounting",
|
|
"export": "getAccountingAccounts"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "listAccountingEvents",
|
|
"method": "GET",
|
|
"path": "/api/v1/accounting/events",
|
|
"pages": ["PAGE-16"],
|
|
"api": {
|
|
"module": "accounting",
|
|
"export": "getAccountingEvents"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "generateVoucherDraft",
|
|
"method": "POST",
|
|
"path": "/api/v1/accounting/events/{publicId}/generate-draft",
|
|
"pages": ["PAGE-16"],
|
|
"api": {
|
|
"module": "accounting",
|
|
"export": "generateVoucherDraft"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "listVouchers",
|
|
"method": "GET",
|
|
"path": "/api/v1/accounting/vouchers",
|
|
"pages": ["PAGE-16"],
|
|
"api": {
|
|
"module": "accounting",
|
|
"export": "getAccountingVouchers"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getVoucher",
|
|
"method": "GET",
|
|
"path": "/api/v1/accounting/vouchers/{publicId}",
|
|
"pages": ["PAGE-16"],
|
|
"api": {
|
|
"module": "accounting",
|
|
"export": "getAccountingVoucher"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "updateVoucher",
|
|
"method": "PATCH",
|
|
"path": "/api/v1/accounting/vouchers/{publicId}",
|
|
"pages": ["PAGE-16"],
|
|
"api": {
|
|
"module": "accounting",
|
|
"export": "updateAccountingVoucher"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "submitVoucher",
|
|
"method": "POST",
|
|
"path": "/api/v1/accounting/vouchers/{publicId}/submit",
|
|
"pages": ["PAGE-16"],
|
|
"api": {
|
|
"module": "accounting",
|
|
"export": "submitAccountingVoucher"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "approveVoucher",
|
|
"method": "POST",
|
|
"path": "/api/v1/accounting/vouchers/{publicId}/approve",
|
|
"pages": ["PAGE-16"],
|
|
"api": {
|
|
"module": "accounting",
|
|
"export": "approveAccountingVoucher"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "returnVoucher",
|
|
"method": "POST",
|
|
"path": "/api/v1/accounting/vouchers/{publicId}/return",
|
|
"pages": ["PAGE-16"],
|
|
"api": {
|
|
"module": "accounting",
|
|
"export": "returnAccountingVoucher"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "exportVoucher",
|
|
"method": "POST",
|
|
"path": "/api/v1/accounting/vouchers/{publicId}/export",
|
|
"pages": ["PAGE-16"],
|
|
"api": {
|
|
"module": "accounting",
|
|
"export": "exportAccountingVoucher"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "downloadVoucherExport",
|
|
"method": "GET",
|
|
"path": "/api/v1/accounting/vouchers/{publicId}/export-file",
|
|
"pages": ["PAGE-16"],
|
|
"responseType": "blob",
|
|
"api": {
|
|
"module": "accounting",
|
|
"export": "downloadAccountingVoucherExport"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "downloadVoucherResultEvidence",
|
|
"method": "GET",
|
|
"path": "/api/v1/accounting/vouchers/{voucherPublicId}/result-files/{filePublicId}/content",
|
|
"pages": ["PAGE-16"],
|
|
"responseType": "blob",
|
|
"api": {
|
|
"module": "accounting",
|
|
"export": "downloadAccountingVoucherResultEvidence"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "recordVoucherResult",
|
|
"method": "POST",
|
|
"path": "/api/v1/accounting/vouchers/{publicId}/record-result",
|
|
"pages": ["PAGE-16"],
|
|
"api": {
|
|
"module": "accounting",
|
|
"export": "recordAccountingResult"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "verifyVoucherResult",
|
|
"method": "POST",
|
|
"path": "/api/v1/accounting/vouchers/{publicId}/verify-result",
|
|
"pages": ["PAGE-16"],
|
|
"api": {
|
|
"module": "accounting",
|
|
"export": "verifyAccountingResult"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "reverseVoucherResult",
|
|
"method": "POST",
|
|
"path": "/api/v1/accounting/vouchers/{publicId}/reverse-result",
|
|
"pages": ["PAGE-16"],
|
|
"api": {
|
|
"module": "accounting",
|
|
"export": "reverseAccountingResult"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "reopenVoucherResult",
|
|
"method": "POST",
|
|
"path": "/api/v1/accounting/vouchers/{publicId}/reopen-result",
|
|
"pages": ["PAGE-16"],
|
|
"api": {
|
|
"module": "accounting",
|
|
"export": "reopenAccountingResult"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "voidVoucher",
|
|
"method": "POST",
|
|
"path": "/api/v1/accounting/vouchers/{publicId}/void",
|
|
"pages": ["PAGE-16"],
|
|
"api": {
|
|
"module": "accounting",
|
|
"export": "voidAccountingVoucher"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "listArchivePackages",
|
|
"method": "GET",
|
|
"path": "/api/v1/archive/packages",
|
|
"pages": ["PAGE-17"],
|
|
"api": {
|
|
"module": "archive",
|
|
"export": "getArchivePackages"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getArchivePackage",
|
|
"method": "GET",
|
|
"path": "/api/v1/archive/packages/{publicId}",
|
|
"pages": ["PAGE-17"],
|
|
"api": {
|
|
"module": "archive",
|
|
"export": "getArchivePackage"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "createArchivePackage",
|
|
"method": "POST",
|
|
"path": "/api/v1/archive/packages",
|
|
"pages": ["PAGE-17"],
|
|
"api": {
|
|
"module": "archive",
|
|
"export": "createArchivePackage"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "checkArchivePackage",
|
|
"method": "POST",
|
|
"path": "/api/v1/archive/packages/{publicId}/check",
|
|
"pages": ["PAGE-17"],
|
|
"api": {
|
|
"module": "archive",
|
|
"export": "checkArchivePackage"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "submitArchivePackage",
|
|
"method": "POST",
|
|
"path": "/api/v1/archive/packages/{publicId}/submit",
|
|
"pages": ["PAGE-17"],
|
|
"api": {
|
|
"module": "archive",
|
|
"export": "submitArchivePackage"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "returnArchivePackage",
|
|
"method": "POST",
|
|
"path": "/api/v1/archive/packages/{publicId}/return",
|
|
"pages": ["PAGE-17"],
|
|
"api": {
|
|
"module": "archive",
|
|
"export": "returnArchivePackage"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "reviseArchivePackage",
|
|
"method": "POST",
|
|
"path": "/api/v1/archive/packages/{publicId}/revise",
|
|
"pages": ["PAGE-17"],
|
|
"api": {
|
|
"module": "archive",
|
|
"export": "reviseArchivePackage"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "archivePackage",
|
|
"method": "POST",
|
|
"path": "/api/v1/archive/packages/{publicId}/archive",
|
|
"pages": ["PAGE-17"],
|
|
"api": {
|
|
"module": "archive",
|
|
"export": "archiveArchivePackage"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "freezeArchivePackage",
|
|
"method": "POST",
|
|
"path": "/api/v1/archive/packages/{publicId}/freeze",
|
|
"pages": ["PAGE-17"],
|
|
"api": {
|
|
"module": "archive",
|
|
"export": "freezeArchivePackage"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "unfreezeArchivePackage",
|
|
"method": "POST",
|
|
"path": "/api/v1/archive/packages/{publicId}/unfreeze",
|
|
"pages": ["PAGE-17"],
|
|
"api": {
|
|
"module": "archive",
|
|
"export": "unfreezeArchivePackage"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "markArchiveItemNotApplicable",
|
|
"method": "POST",
|
|
"path": "/api/v1/archive/packages/{packageId}/items/{itemId}/not-applicable",
|
|
"pages": ["PAGE-17"],
|
|
"api": {
|
|
"module": "archive",
|
|
"export": "markArchiveItemNotApplicable"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "reviewArchiveItemNotApplicable",
|
|
"method": "POST",
|
|
"path": "/api/v1/archive/packages/{packageId}/items/{itemId}/not-applicable/review",
|
|
"pages": ["PAGE-17"],
|
|
"api": {
|
|
"module": "archive",
|
|
"export": "reviewArchiveItemNotApplicable"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "listArchiveFiles",
|
|
"method": "GET",
|
|
"path": "/api/v1/archive/files",
|
|
"pages": ["PAGE-18"],
|
|
"api": {
|
|
"module": "archive",
|
|
"export": "getArchiveFiles"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getArchiveFile",
|
|
"method": "GET",
|
|
"path": "/api/v1/archive/files/{publicId}",
|
|
"pages": ["PAGE-18"],
|
|
"api": {
|
|
"module": "archive",
|
|
"export": "getArchiveFile"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "rescanArchiveFile",
|
|
"method": "POST",
|
|
"path": "/api/v1/archive/files/{publicId}/rescan",
|
|
"pages": ["PAGE-18"],
|
|
"api": {
|
|
"module": "archive",
|
|
"export": "rescanArchiveFile"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getArchiveFileContent",
|
|
"method": "GET",
|
|
"path": "/api/v1/archive/files/{publicId}/content",
|
|
"pages": ["PAGE-18"],
|
|
"responseType": "blob",
|
|
"variants": [
|
|
{
|
|
"name": "preview",
|
|
"query": {
|
|
"preview": true
|
|
}
|
|
},
|
|
{
|
|
"name": "download",
|
|
"query": {
|
|
"preview": false
|
|
}
|
|
}
|
|
],
|
|
"api": {
|
|
"module": "archive",
|
|
"export": "getArchiveFileContent"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "uploadArchiveFile",
|
|
"method": "POST",
|
|
"path": "/api/v1/archive/files",
|
|
"pages": ["PAGE-17", "PAGE-18"],
|
|
"requestType": "multipart",
|
|
"api": {
|
|
"module": "archive",
|
|
"export": "uploadArchiveFile"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "listBorrows",
|
|
"method": "GET",
|
|
"path": "/api/v1/archive/borrows",
|
|
"pages": ["PAGE-18"],
|
|
"api": {
|
|
"module": "archive",
|
|
"export": "getArchiveBorrows"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "createBorrow",
|
|
"method": "POST",
|
|
"path": "/api/v1/archive/borrows",
|
|
"pages": ["PAGE-18"],
|
|
"api": {
|
|
"module": "archive",
|
|
"export": "createArchiveBorrow"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "approveBorrow",
|
|
"method": "POST",
|
|
"path": "/api/v1/archive/borrows/{publicId}/approve",
|
|
"pages": ["PAGE-18"],
|
|
"api": {
|
|
"module": "archive",
|
|
"export": "approveArchiveBorrow"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "rejectBorrow",
|
|
"method": "POST",
|
|
"path": "/api/v1/archive/borrows/{publicId}/reject",
|
|
"pages": ["PAGE-18"],
|
|
"api": {
|
|
"module": "archive",
|
|
"export": "rejectArchiveBorrow"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "returnBorrow",
|
|
"method": "POST",
|
|
"path": "/api/v1/archive/borrows/{publicId}/return",
|
|
"pages": ["PAGE-18"],
|
|
"api": {
|
|
"module": "archive",
|
|
"export": "returnArchiveBorrow"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getReport",
|
|
"method": "GET",
|
|
"path": "/api/v1/reports/{reportCode}",
|
|
"pages": ["PAGE-19"],
|
|
"api": {
|
|
"module": "reports",
|
|
"export": "getReport"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getReportDrilldown",
|
|
"method": "GET",
|
|
"path": "/api/v1/reports/{reportCode}/{rowId}/drilldown",
|
|
"pages": ["PAGE-19"],
|
|
"api": {
|
|
"module": "reports",
|
|
"export": "getReportDrilldown"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "prepareReportExport",
|
|
"method": "POST",
|
|
"path": "/api/v1/reports/{reportCode}/exports/prepare",
|
|
"pages": ["PAGE-19"],
|
|
"api": {
|
|
"module": "reports",
|
|
"export": "prepareReportExport"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "confirmReportExport",
|
|
"method": "POST",
|
|
"path": "/api/v1/reports/{reportCode}/exports/confirm",
|
|
"pages": ["PAGE-19"],
|
|
"api": {
|
|
"module": "reports",
|
|
"export": "confirmReportExport"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "listAuditLogs",
|
|
"method": "GET",
|
|
"path": "/api/v1/audit/logs",
|
|
"pages": ["PAGE-20", "PAGE-22"],
|
|
"api": {
|
|
"module": "audit",
|
|
"export": "getAuditLogs"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getAuditLog",
|
|
"method": "GET",
|
|
"path": "/api/v1/audit/logs/{publicId}",
|
|
"pages": ["PAGE-20"],
|
|
"api": {
|
|
"module": "audit",
|
|
"export": "getAuditLog"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "exportAuditLogs",
|
|
"method": "POST",
|
|
"path": "/api/v1/audit/exports",
|
|
"pages": ["PAGE-20"],
|
|
"api": {
|
|
"module": "audit",
|
|
"export": "exportAuditLogs"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "listGovernanceResources",
|
|
"method": "GET",
|
|
"path": "/api/v1/admin/{resource}",
|
|
"pages": ["PAGE-21"],
|
|
"api": {
|
|
"module": "governance",
|
|
"export": "getGovernanceResource"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getGovernanceResource",
|
|
"method": "GET",
|
|
"path": "/api/v1/admin/{resource}/{publicId}",
|
|
"pages": ["PAGE-21"],
|
|
"api": {
|
|
"module": "governance",
|
|
"export": "getGovernanceDetail"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "createGovernanceResource",
|
|
"method": "POST",
|
|
"path": "/api/v1/admin/{resource}",
|
|
"pages": ["PAGE-21"],
|
|
"api": {
|
|
"module": "governance",
|
|
"export": "createGovernanceResource"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "updateGovernanceResource",
|
|
"method": "PATCH",
|
|
"path": "/api/v1/admin/{resource}/{publicId}",
|
|
"pages": ["PAGE-21"],
|
|
"api": {
|
|
"module": "governance",
|
|
"export": "updateGovernanceResource"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "commandGovernanceResource",
|
|
"method": "POST",
|
|
"path": "/api/v1/admin/{resource}/{publicId}/{command}",
|
|
"pages": ["PAGE-21"],
|
|
"api": {
|
|
"module": "governance",
|
|
"export": "commandGovernanceResource"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getSystemUpdateStatus",
|
|
"method": "GET",
|
|
"path": "/api/v1/admin/system-update",
|
|
"pages": ["PAGE-22"],
|
|
"api": {
|
|
"module": "system-update",
|
|
"export": "getSystemUpdateStatus"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "checkSystemUpdate",
|
|
"method": "POST",
|
|
"path": "/api/v1/admin/system-update/check",
|
|
"pages": ["PAGE-22"],
|
|
"api": {
|
|
"module": "system-update",
|
|
"export": "checkSystemUpdate"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "downloadSystemUpdate",
|
|
"method": "POST",
|
|
"path": "/api/v1/admin/system-update/download",
|
|
"pages": ["PAGE-22"],
|
|
"api": {
|
|
"module": "system-update",
|
|
"export": "downloadSystemUpdate"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "installSystemUpdate",
|
|
"method": "POST",
|
|
"path": "/api/v1/admin/system-update/install",
|
|
"pages": ["PAGE-22"],
|
|
"api": {
|
|
"module": "system-update",
|
|
"export": "installSystemUpdate"
|
|
}
|
|
},
|
|
{
|
|
"operationId": "getDashboardOverview",
|
|
"method": "GET",
|
|
"path": "/api/v1/dashboard/overview",
|
|
"pages": ["PAGE-24"],
|
|
"api": {
|
|
"module": "dashboard",
|
|
"export": "getDashboardOverview"
|
|
}
|
|
}
|
|
],
|
|
"infrastructure": [
|
|
{
|
|
"id": "csrf-bootstrap",
|
|
"method": "GET",
|
|
"path": "/api/v1/auth/csrf",
|
|
"source": "src/utils/request/index.ts"
|
|
}
|
|
]
|
|
}
|