{ "uuid": "9456d894-dad6-4bcf-82b8-ed21613c5469", "lastMigration": 29, "name": "WeGA API", "endpointPrefix": "api/v1", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "b20e7469-3743-4fd5-843a-3227139b1b3c", "documentation": "Create a new WeGA ID", "method": "get", "endpoint": "application/newID", "responses": [ { "uuid": "056bbd38-202a-4fa7-a524-7eed8246a0a2", "body": "{\n \"docID\": \"\",\n \"docType\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "A single object with a fresh WeGA ID", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2c92c2f8-b1df-449d-b646-057bae8a9bfd", "body": "{\n \"code\": 403,\n \"message\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "The creation of new IDs is only available in the development environment", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "13209a17-5027-4cb1-80b4-28f0eb2fe561", "body": "{\n \"code\": {{faker 'number.int' max=99999}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bfec8a62-3062-4d03-9c66-637213cff195", "documentation": "Get status information about the running WeGA-WebApp", "method": "get", "endpoint": "application/status", "responses": [ { "uuid": "9ea5e4ac-b1eb-403a-8231-ee6b9f83e1ea", "body": "{\n \"deployment\": \"{{faker 'date.recent' 365}}\",\n \"status\": \"healthy\",\n \"svnRevision\": {{faker 'number.int' max=99999}},\n \"version\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Healthy – A single object with status information", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "279497a9-85ea-4227-a68b-c45359981ade", "body": "{\n \"deployment\": \"{{faker 'date.recent' 365}}\",\n \"status\": \"unhealthy\",\n \"svnRevision\": {{faker 'number.int' max=99999}},\n \"version\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Unhealthy – A single object with status information", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "067a30f6-9a1d-4866-a26d-3949a0c740ae", "body": "{\n \"code\": {{faker 'number.int' max=99999}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6f7fb629-93c7-46d6-bd7c-163fc759fcb8", "documentation": "Finds code samples by XML element", "method": "get", "endpoint": "code/findByElement/:element", "responses": [ { "uuid": "8307edb3-63e5-435f-a9be-dd00ef41fd08", "body": "[\n {\n \"codeSample\": \"\",\n \"docID\": \"\",\n \"uri\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "An array of documents", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "totalrecordcount", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a991e103-5f0d-44d2-bda8-1226a19628cb", "body": "{\n \"code\": {{faker 'number.int' max=99999}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5b9ce846-e781-4f2f-87b2-9229ee179096", "documentation": "Lists all documents", "method": "get", "endpoint": "documents", "responses": [ { "uuid": "1d769242-b70b-4e5f-8f3c-bbc89c32bccb", "body": "[\n {\n \"docID\": \"\",\n \"docType\": \"\",\n \"title\": \"\",\n \"uri\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "An array of documents", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "totalrecordcount", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "25f3f0c5-c39e-4236-9c53-fcf92aecab67", "body": "{\n \"code\": {{faker 'number.int' max=99999}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9602a40c-8179-4e1d-9c3d-e911768537d2", "documentation": "Finds documents by author", "method": "get", "endpoint": "documents/findByAuthor/:authorID", "responses": [ { "uuid": "93e13d5b-ee17-4660-aaaf-c572a19da8c7", "body": "[\n {\n \"docID\": \"\",\n \"docType\": \"\",\n \"title\": \"\",\n \"uri\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "An array of documents", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "totalrecordcount", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "343486d3-7fa9-4071-8eba-b93feffd2c0f", "body": "{\n \"code\": {{faker 'number.int' max=99999}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4922c899-d1a7-434c-a42d-c21d5707149e", "documentation": "Finds documents by date", "method": "get", "endpoint": "documents/findByDate", "responses": [ { "uuid": "e466e6fa-99d3-4cad-85ac-03e3cfc892a1", "body": "[\n {\n \"docID\": \"\",\n \"docType\": \"\",\n \"title\": \"\",\n \"uri\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "An array of documents", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "totalrecordcount", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9c10ae12-ea34-4d0b-a062-c16728102e4e", "body": "{\n \"code\": {{faker 'number.int' max=99999}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5f05962a-e8ff-42cc-bc0d-6e6708979974", "documentation": "Finds documents by reference", "method": "get", "endpoint": "documents/findByMention/:docID", "responses": [ { "uuid": "f504a9e2-865a-4e50-b14e-bad6a90f2515", "body": "[\n {\n \"docID\": \"\",\n \"docType\": \"\",\n \"title\": \"\",\n \"uri\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "An array of documents", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "totalrecordcount", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "eb9c37f1-bee1-436e-8f1f-66227d7a6cbe", "body": "{\n \"code\": {{faker 'number.int' max=99999}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "86bfe900-2106-4c84-b7d1-c60f92bde0b6", "documentation": "Returns documents by ID", "method": "get", "endpoint": "documents/:docID", "responses": [ { "uuid": "cfdf8e48-5fcd-4c42-9b5e-5bed939b4cf4", "body": "[\n {\n \"docID\": \"\",\n \"docType\": \"\",\n \"title\": \"\",\n \"uri\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "An array of documents", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b085595f-e157-434e-82b2-c144a80b003f", "body": "{\n \"code\": {{faker 'number.int' max=99999}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6cfedec7-adf0-4abd-9d76-ffa3238772f1", "documentation": "Returns facets", "method": "get", "endpoint": "facets/:facet", "responses": [ { "uuid": "5fdab289-4c93-4633-9652-cf4a7d2b80c0", "body": "[\n {\n \"frequency\": {{faker 'number.int' max=99999}},\n \"label\": \"\",\n \"value\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "An array of facets", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "totalrecordcount", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "22494f97-3837-42bf-b93a-d40c71c56a30", "body": "{\n \"code\": {{faker 'number.int' max=99999}},\n \"fields\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Unexpected error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "b20e7469-3743-4fd5-843a-3227139b1b3c" }, { "type": "route", "uuid": "bfec8a62-3062-4d03-9c66-637213cff195" }, { "type": "route", "uuid": "6f7fb629-93c7-46d6-bd7c-163fc759fcb8" }, { "type": "route", "uuid": "5b9ce846-e781-4f2f-87b2-9229ee179096" }, { "type": "route", "uuid": "9602a40c-8179-4e1d-9c3d-e911768537d2" }, { "type": "route", "uuid": "4922c899-d1a7-434c-a42d-c21d5707149e" }, { "type": "route", "uuid": "5f05962a-e8ff-42cc-bc0d-6e6708979974" }, { "type": "route", "uuid": "86bfe900-2106-4c84-b7d1-c60f92bde0b6" }, { "type": "route", "uuid": "6cfedec7-adf0-4abd-9d76-ffa3238772f1" } ] }