{ "item": [ { "name": "Misc", "description": "", "item": [ { "id": "482416dc-1312-4794-9d60-dc159c205dec", "name": "Me", "request": { "name": "Me", "description": { "content": "A simple endpoint for testing your connection to the Ardoq server.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "me" ], "host": [ "{{ARDOQ_API_HOST}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "References", "description": "", "item": [ { "id": "322a8886-a3b9-43da-b455-80ccfde51623", "name": "List References", "request": { "name": "List References", "description": { "content": "List all references. Query parameters can be used to retrieve a subset of the collection. All included query parameters are interpreted as forming a logical **conjunction**, meaning that only the references that satisfy every property will be returned. The list endpoint supports searching for custom fields. When searching for a custom field, the value is interpreted based on the type associated with the field. This means that you are not required to _quote_ strings. To include a **custom field** in your search, you should specify the JSON path. For example; if you wanted to search for all references that have the **displayText** \"Ardoq\" and the **custom field** `my_field` with a boolean value of `true` you would use the query param:\n\n```displayText=Ardoq&customFields.my_field=true```", "type": "text/plain" }, "url": { "path": [ "api", "v2", "references" ], "host": [ "{{ARDOQ_API_HOST}}" ], "query": [ { "disabled": true, "description": { "content": "Display label for your reference.", "type": "text/plain" }, "key": "displayText", "value": "" }, { "disabled": true, "description": { "content": "The ardoq identifier of the workspace that the reference/source belongs to.", "type": "text/plain" }, "key": "rootWorkspace", "value": "" }, { "disabled": true, "description": { "content": "The ardoq identifier of the source.", "type": "text/plain" }, "key": "source", "value": "" }, { "disabled": true, "description": { "content": "The ardoq identifier of the workspace that the target belongs to.", "type": "text/plain" }, "key": "targetWorkspace", "value": "" }, { "disabled": true, "description": { "content": "The ardoq identifier of the target.", "type": "text/plain" }, "key": "target", "value": "" }, { "disabled": true, "description": { "content": "The type identifier of the reference.", "type": "text/plain" }, "key": "type", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3dace772-4361-410d-8a78-c745a2c99c0b", "name": "Create a Reference", "request": { "name": "Create a Reference", "description": { "content": "References are connections between components.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "references" ], "host": [ "{{ARDOQ_API_HOST}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"customFields\": {\n \"ea_94\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"esta16\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"displayText\": \"\",\n \"description\": {\n \"nullable\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "862b9fbd-f597-49a8-a589-62dedb286996", "name": "Batch", "request": { "name": "Batch", "description": { "content": "The Batch API lets you combine **create**, **update** and **delete** operations on both components and references belonging to disparate workspaces into a single request. All operations are executed within a transaction. If **any** of the operations fail then the whole request will fail leaving the state of Ardoq unmodified.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "batch" ], "host": [ "{{ARDOQ_API_HOST}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"options\": {\n \"respondWithEntities\": \"\"\n },\n \"aliases\": {\n \"components\": {\n \"voluptate_bd\": {\n \"customFields\": {\n \"dolore_7d2\": \"\"\n },\n \"rootWorkspace\": \"\",\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"componentKey\": \"\"\n }\n },\n \"references\": {\n \"ut_04\": {\n \"customFields\": {\n \"et_00\": \"\"\n },\n \"rootWorkspace\": \"\",\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\"\n }\n }\n },\n \"components\": {\n \"create\": [\n {\n \"body\": {\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"rootWorkspace\": \"\",\n \"typeId\": {\n \"title\": \"Component Type Id\",\n \"description\": \"Component types are drawn from the type-hierarchy defined by the workspace's metamodel.\",\n \"example\": \"p7343097242684\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"sede\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"nulla33\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"voluptate_06\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"icon\": \"\"\n },\n \"batchId\": \"\"\n },\n {\n \"body\": {\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"rootWorkspace\": \"\",\n \"typeId\": {\n \"title\": \"Component Type Id\",\n \"description\": \"Component types are drawn from the type-hierarchy defined by the workspace's metamodel.\",\n \"example\": \"p7343097242684\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"voluptate4\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"icon\": \"\"\n },\n \"batchId\": \"\"\n }\n ],\n \"upsert\": [\n {\n \"uniqueBy\": [\n \"\",\n \"\"\n ],\n \"body\": {\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"rootWorkspace\": \"\",\n \"typeId\": {\n \"title\": \"Component Type Id\",\n \"description\": \"Component types are drawn from the type-hierarchy defined by the workspace's metamodel.\",\n \"example\": \"p7343097242684\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"est_0\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"icon\": \"\"\n },\n \"batchId\": \"\"\n },\n {\n \"uniqueBy\": [\n \"\",\n \"\"\n ],\n \"body\": {\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"rootWorkspace\": \"\",\n \"typeId\": {\n \"title\": \"Component Type Id\",\n \"description\": \"Component types are drawn from the type-hierarchy defined by the workspace's metamodel.\",\n \"example\": \"p7343097242684\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"sint_b72\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"nostrud_1\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"qui133\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"icon\": \"\"\n },\n \"batchId\": \"\"\n }\n ],\n \"update\": [\n {\n \"id\": \"\",\n \"ifVersionMatch\": \"\",\n \"body\": {\n \"customFields\": {\n \"veniam_6_\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"deseruntbb\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"description\": {\n \"nullable\": true\n },\n \"color\": \"\",\n \"shape\": \"\",\n \"icon\": \"\",\n \"image\": \"\",\n \"parent\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"ifVersionMatch\": \"\",\n \"body\": {\n \"customFields\": {\n \"qui8\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"commodo_a0\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"description\": {\n \"nullable\": true\n },\n \"color\": \"\",\n \"shape\": \"\",\n \"icon\": \"\",\n \"image\": \"\",\n \"parent\": \"\"\n }\n }\n ],\n \"delete\": [\n {\n \"id\": \"\",\n \"match\": {\n \"customFields\": {\n \"sit53c\": \"\"\n },\n \"rootWorkspace\": \"\",\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"componentKey\": \"\",\n \"typeId\": {\n \"title\": \"Component Type Id\",\n \"description\": \"Component types are drawn from the type-hierarchy defined by the workspace's metamodel.\",\n \"example\": \"p7343097242684\"\n }\n }\n },\n {\n \"id\": \"\",\n \"match\": {\n \"customFields\": {\n \"pariatur_f7\": \"\"\n },\n \"rootWorkspace\": \"\",\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"componentKey\": \"\",\n \"typeId\": {\n \"title\": \"Component Type Id\",\n \"description\": \"Component types are drawn from the type-hierarchy defined by the workspace's metamodel.\",\n \"example\": \"p7343097242684\"\n }\n }\n }\n ]\n },\n \"references\": {\n \"create\": [\n {\n \"body\": {\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"customFields\": {\n \"quis939\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"displayText\": \"\",\n \"description\": {\n \"nullable\": true\n }\n },\n \"batchId\": \"\"\n },\n {\n \"body\": {\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"customFields\": {\n \"aliquip261\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"ipsum6\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"displayText\": \"\",\n \"description\": {\n \"nullable\": true\n }\n },\n \"batchId\": \"\"\n }\n ],\n \"upsert\": [\n {\n \"uniqueBy\": [\n \"\",\n \"\"\n ],\n \"body\": {\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"customFields\": {\n \"cillum_c\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"displayText\": \"\",\n \"description\": {\n \"nullable\": true\n }\n },\n \"batchId\": \"\"\n },\n {\n \"uniqueBy\": [\n \"\",\n \"\"\n ],\n \"body\": {\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"customFields\": {\n \"nulla_078\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"displayText\": \"\",\n \"description\": {\n \"nullable\": true\n }\n },\n \"batchId\": \"\"\n }\n ],\n \"update\": [\n {\n \"id\": \"\",\n \"ifVersionMatch\": \"\",\n \"body\": {\n \"customFields\": {\n \"sit_4a5\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"Lorem_2\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"displayText\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"source\": \"\",\n \"target\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"ifVersionMatch\": \"\",\n \"body\": {\n \"customFields\": {\n \"commodo_6c\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"fugiatce_\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"dolor8ae\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"ullamcoc\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"displayText\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"source\": \"\",\n \"target\": \"\"\n }\n }\n ],\n \"delete\": [\n {\n \"id\": \"\",\n \"match\": {\n \"customFields\": {\n \"labore_0e_\": \"\",\n \"id_5\": \"\",\n \"est_c3\": \"\",\n \"id_fd6\": \"\"\n },\n \"rootWorkspace\": \"\",\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"targetWorkspace\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"match\": {\n \"customFields\": {\n \"Excepteur408\": \"\"\n },\n \"rootWorkspace\": \"\",\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"targetWorkspace\": \"\"\n }\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c4c2633e-6216-41e4-ae57-a775078538f1", "name": "Get a reference", "request": { "name": "Get a reference", "description": { "content": "Get a reference associated with a given Ardoq Identifier.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "references", ":id" ], "host": [ "{{ARDOQ_API_HOST}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) An Ardoq identifier (OID)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5c159ab4-6436-4fde-b44b-b1460e1d2512", "name": "Delete a reference", "request": { "name": "Delete a reference", "description": { "content": "Delete a reference associated with a given Ardoq Identifier.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "references", ":id" ], "host": [ "{{ARDOQ_API_HOST}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) An Ardoq identifier (OID)", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "061e5a48-fa30-4aae-b478-50d50b30e855", "name": "Update a Reference", "request": { "name": "Update a Reference", "description": { "content": "References are connections between components.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "references", ":id" ], "host": [ "{{ARDOQ_API_HOST}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) This parameter is used to manage concurrency control. The value **MUST** be either a positive integer, or the enum `latest`. \n| Value | Meaning |\n|--------|---------|\n|``| The update **MUST** fail if the `_version` field of the stored entity is not identical to the provided value. |\\n|`latest` | The update should use the current (latest) version of the stored entity. |\n\nFor more information about versioning and concurrency control please see the [API guide on Versioning](/api-guides/concepts/versioning/).", "type": "text/plain" }, "key": "ifVersionMatch", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) An Ardoq identifier (OID)", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"customFields\": {\n \"ipsum_b31\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"displayText\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"source\": \"\",\n \"target\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Attachments", "description": "", "item": [ { "id": "e4cac856-f813-44e3-a968-9c466f0c74cf", "name": "List attachments", "request": { "name": "List attachments", "description": { "content": "List all attachments. Query parameters can be used to retrieve a subset of the attachments. All included query parameters are interpreted as forming a logical **conjunction**, meaning that only attachments that satisfy every property will be returned. ", "type": "text/plain" }, "url": { "path": [ "api", "v2", "attachments" ], "host": [ "{{ARDOQ_API_HOST}}" ], "query": [ { "disabled": true, "description": { "content": "The filename of the attachment.", "type": "text/plain" }, "key": "filename", "value": "" }, { "disabled": true, "description": { "content": "The `id` of the folder that the attachment is in.", "type": "text/plain" }, "key": "folder", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "edad13a6-dedd-40ca-b20c-d55ef4f92eb7", "name": "Get an attachment", "request": { "name": "Get an attachment", "description": { "content": "Get an attachment associated with a given Ardoq Identifier.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "attachments", ":id" ], "host": [ "{{ARDOQ_API_HOST}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) An Ardoq identifier (OID)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Components", "description": "", "item": [ { "id": "df09ba12-6e08-459d-98c3-ce5b0f3e8b24", "name": "Get a component", "request": { "name": "Get a component", "description": { "content": "Get a component associated with a given Ardoq Identifier.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "components", ":id" ], "host": [ "{{ARDOQ_API_HOST}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) An Ardoq identifier (OID)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a183e852-424e-47b4-8628-b7e71e674b1b", "name": "Delete a component", "request": { "name": "Delete a component", "description": { "content": "Delete a component associated with a given Ardoq Identifier.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "components", ":id" ], "host": [ "{{ARDOQ_API_HOST}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) An Ardoq identifier (OID)", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d4561214-12cf-4f88-a618-0e8cf35fb8cc", "name": "Update a component", "request": { "name": "Update a component", "description": { "content": "Update a component associated with a given Ardoq Identifier.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "components", ":id" ], "host": [ "{{ARDOQ_API_HOST}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) This parameter is used to manage concurrency control. The value **MUST** be either a positive integer, or the enum `latest`. \n| Value | Meaning |\n|--------|---------|\n|``| The update **MUST** fail if the `_version` field of the stored entity is not identical to the provided value. |\\n|`latest` | The update should use the current (latest) version of the stored entity. |\n\nFor more information about versioning and concurrency control please see the [API guide on Versioning](/api-guides/concepts/versioning/).", "type": "text/plain" }, "key": "ifVersionMatch", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) An Ardoq identifier (OID)", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"customFields\": {\n \"minim1d2\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"description\": {\n \"nullable\": true\n },\n \"color\": \"\",\n \"shape\": \"\",\n \"icon\": \"\",\n \"image\": \"\",\n \"parent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "48b44b75-c6c3-4ffa-9f76-46e6c79f8a21", "name": "Batch", "request": { "name": "Batch", "description": { "content": "The Batch API lets you combine **create**, **update** and **delete** operations on both components and references belonging to disparate workspaces into a single request. All operations are executed within a transaction. If **any** of the operations fail then the whole request will fail leaving the state of Ardoq unmodified.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "batch" ], "host": [ "{{ARDOQ_API_HOST}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"options\": {\n \"respondWithEntities\": \"\"\n },\n \"aliases\": {\n \"components\": {\n \"voluptate_bd\": {\n \"customFields\": {\n \"dolore_7d2\": \"\"\n },\n \"rootWorkspace\": \"\",\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"componentKey\": \"\"\n }\n },\n \"references\": {\n \"ut_04\": {\n \"customFields\": {\n \"et_00\": \"\"\n },\n \"rootWorkspace\": \"\",\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\"\n }\n }\n },\n \"components\": {\n \"create\": [\n {\n \"body\": {\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"rootWorkspace\": \"\",\n \"typeId\": {\n \"title\": \"Component Type Id\",\n \"description\": \"Component types are drawn from the type-hierarchy defined by the workspace's metamodel.\",\n \"example\": \"p7343097242684\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"sede\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"nulla33\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"voluptate_06\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"icon\": \"\"\n },\n \"batchId\": \"\"\n },\n {\n \"body\": {\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"rootWorkspace\": \"\",\n \"typeId\": {\n \"title\": \"Component Type Id\",\n \"description\": \"Component types are drawn from the type-hierarchy defined by the workspace's metamodel.\",\n \"example\": \"p7343097242684\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"voluptate4\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"icon\": \"\"\n },\n \"batchId\": \"\"\n }\n ],\n \"upsert\": [\n {\n \"uniqueBy\": [\n \"\",\n \"\"\n ],\n \"body\": {\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"rootWorkspace\": \"\",\n \"typeId\": {\n \"title\": \"Component Type Id\",\n \"description\": \"Component types are drawn from the type-hierarchy defined by the workspace's metamodel.\",\n \"example\": \"p7343097242684\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"est_0\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"icon\": \"\"\n },\n \"batchId\": \"\"\n },\n {\n \"uniqueBy\": [\n \"\",\n \"\"\n ],\n \"body\": {\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"rootWorkspace\": \"\",\n \"typeId\": {\n \"title\": \"Component Type Id\",\n \"description\": \"Component types are drawn from the type-hierarchy defined by the workspace's metamodel.\",\n \"example\": \"p7343097242684\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"sint_b72\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"nostrud_1\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"qui133\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"icon\": \"\"\n },\n \"batchId\": \"\"\n }\n ],\n \"update\": [\n {\n \"id\": \"\",\n \"ifVersionMatch\": \"\",\n \"body\": {\n \"customFields\": {\n \"veniam_6_\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"deseruntbb\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"description\": {\n \"nullable\": true\n },\n \"color\": \"\",\n \"shape\": \"\",\n \"icon\": \"\",\n \"image\": \"\",\n \"parent\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"ifVersionMatch\": \"\",\n \"body\": {\n \"customFields\": {\n \"qui8\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"commodo_a0\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"description\": {\n \"nullable\": true\n },\n \"color\": \"\",\n \"shape\": \"\",\n \"icon\": \"\",\n \"image\": \"\",\n \"parent\": \"\"\n }\n }\n ],\n \"delete\": [\n {\n \"id\": \"\",\n \"match\": {\n \"customFields\": {\n \"sit53c\": \"\"\n },\n \"rootWorkspace\": \"\",\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"componentKey\": \"\",\n \"typeId\": {\n \"title\": \"Component Type Id\",\n \"description\": \"Component types are drawn from the type-hierarchy defined by the workspace's metamodel.\",\n \"example\": \"p7343097242684\"\n }\n }\n },\n {\n \"id\": \"\",\n \"match\": {\n \"customFields\": {\n \"pariatur_f7\": \"\"\n },\n \"rootWorkspace\": \"\",\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"componentKey\": \"\",\n \"typeId\": {\n \"title\": \"Component Type Id\",\n \"description\": \"Component types are drawn from the type-hierarchy defined by the workspace's metamodel.\",\n \"example\": \"p7343097242684\"\n }\n }\n }\n ]\n },\n \"references\": {\n \"create\": [\n {\n \"body\": {\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"customFields\": {\n \"quis939\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"displayText\": \"\",\n \"description\": {\n \"nullable\": true\n }\n },\n \"batchId\": \"\"\n },\n {\n \"body\": {\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"customFields\": {\n \"aliquip261\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"ipsum6\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"displayText\": \"\",\n \"description\": {\n \"nullable\": true\n }\n },\n \"batchId\": \"\"\n }\n ],\n \"upsert\": [\n {\n \"uniqueBy\": [\n \"\",\n \"\"\n ],\n \"body\": {\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"customFields\": {\n \"cillum_c\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"displayText\": \"\",\n \"description\": {\n \"nullable\": true\n }\n },\n \"batchId\": \"\"\n },\n {\n \"uniqueBy\": [\n \"\",\n \"\"\n ],\n \"body\": {\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"customFields\": {\n \"nulla_078\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"displayText\": \"\",\n \"description\": {\n \"nullable\": true\n }\n },\n \"batchId\": \"\"\n }\n ],\n \"update\": [\n {\n \"id\": \"\",\n \"ifVersionMatch\": \"\",\n \"body\": {\n \"customFields\": {\n \"sit_4a5\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"Lorem_2\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"displayText\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"source\": \"\",\n \"target\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"ifVersionMatch\": \"\",\n \"body\": {\n \"customFields\": {\n \"commodo_6c\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"fugiatce_\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"dolor8ae\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"ullamcoc\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"displayText\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"source\": \"\",\n \"target\": \"\"\n }\n }\n ],\n \"delete\": [\n {\n \"id\": \"\",\n \"match\": {\n \"customFields\": {\n \"labore_0e_\": \"\",\n \"id_5\": \"\",\n \"est_c3\": \"\",\n \"id_fd6\": \"\"\n },\n \"rootWorkspace\": \"\",\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"targetWorkspace\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"match\": {\n \"customFields\": {\n \"Excepteur408\": \"\"\n },\n \"rootWorkspace\": \"\",\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"targetWorkspace\": \"\"\n }\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "42fccdf9-65ff-451c-bedd-347594a89660", "name": "List Components", "request": { "name": "List Components", "description": { "content": "List all components. Query parameters can be used to retrieve a subset of the collection. All included query parameters are interpreted as forming a logical **conjunction**, meaning that only the components that satisfy every property will be returned. The list endpoint supports searching for custom fields. When searching for a custom field, the value is interpreted based on the type associated with the field. This means that you are not required to _quote_ strings. To include a **custom field** in your search, you should specify the JSON path. For example; if you wanted to search for all components that have the **name** \"Ardoq\" and the **custom field** `my_field` with a boolean value of `true` you would use the query param:\n\n```name=Ardoq&customFields.my_field=true```", "type": "text/plain" }, "url": { "path": [ "api", "v2", "components" ], "host": [ "{{ARDOQ_API_HOST}}" ], "query": [ { "disabled": true, "description": { "content": "The name of the entity.", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "The ardoq identifier of the workspace that the component belongs to.", "type": "text/plain" }, "key": "rootWorkspace", "value": "" }, { "disabled": true, "description": { "content": "The parent identifier of the component.", "type": "text/plain" }, "key": "parent", "value": "" }, { "disabled": true, "description": { "content": "Referred to as the 'Ardoq ID' in the App", "type": "text/plain" }, "key": "componentKey", "value": "" }, { "disabled": true, "description": { "content": "The type identifier of the component.", "type": "text/plain" }, "key": "typeId", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "727357fb-4ec5-4ecd-b31c-823dd9d6015d", "name": "Create a component", "request": { "name": "Create a component", "description": { "content": "Create a component", "type": "text/plain" }, "url": { "path": [ "api", "v2", "components" ], "host": [ "{{ARDOQ_API_HOST}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"rootWorkspace\": \"\",\n \"typeId\": {\n \"title\": \"Component Type Id\",\n \"description\": \"Component types are drawn from the type-hierarchy defined by the workspace's metamodel.\",\n \"example\": \"p7343097242684\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"do_c7_\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"cupidatat5\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"deserunt_781\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"in_5\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"icon\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Workspaces", "description": "", "item": [ { "id": "b02e559b-f305-49a8-aeff-4ff0eebd8a80", "name": "List Workspaces", "request": { "name": "List Workspaces", "description": { "content": "List all workspaces. Query parameters can be used to retrieve a subset of the workspaces. All included query parameters are interpreted as forming a logical **conjunction**, meaning that only workspaces that satisfy every property will be returned. ", "type": "text/plain" }, "url": { "path": [ "api", "v2", "workspaces" ], "host": [ "{{ARDOQ_API_HOST}}" ], "query": [ { "disabled": true, "description": { "content": "The name of the entity.", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "The ardoq identifier of the model that the workspace has.", "type": "text/plain" }, "key": "componentModel", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b712975c-bdf2-41ba-8dc0-c1be41845595", "name": "Get a workspace", "request": { "name": "Get a workspace", "description": { "content": "Get a workspace associated with a given Ardoq Identifier.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "workspaces", ":id" ], "host": [ "{{ARDOQ_API_HOST}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) An Ardoq identifier (OID)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "82d97b74-9285-48ce-8712-1e076fdb100c", "name": "Workspace Context", "request": { "name": "Workspace Context", "description": { "content": "Information required for interacting with entities that belong to the workspace.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "workspaces", ":id", "context" ], "host": [ "{{ARDOQ_API_HOST}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) An Ardoq identifier (OID)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Batch", "description": "", "item": [ { "id": "c7d09ad0-8bc9-4f1d-8d85-fdd21ce2346d", "name": "Batch", "request": { "name": "Batch", "description": { "content": "The Batch API lets you combine **create**, **update** and **delete** operations on both components and references belonging to disparate workspaces into a single request. All operations are executed within a transaction. If **any** of the operations fail then the whole request will fail leaving the state of Ardoq unmodified.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "batch" ], "host": [ "{{ARDOQ_API_HOST}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"options\": {\n \"respondWithEntities\": \"\"\n },\n \"aliases\": {\n \"components\": {\n \"voluptate_bd\": {\n \"customFields\": {\n \"dolore_7d2\": \"\"\n },\n \"rootWorkspace\": \"\",\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"componentKey\": \"\"\n }\n },\n \"references\": {\n \"ut_04\": {\n \"customFields\": {\n \"et_00\": \"\"\n },\n \"rootWorkspace\": \"\",\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\"\n }\n }\n },\n \"components\": {\n \"create\": [\n {\n \"body\": {\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"rootWorkspace\": \"\",\n \"typeId\": {\n \"title\": \"Component Type Id\",\n \"description\": \"Component types are drawn from the type-hierarchy defined by the workspace's metamodel.\",\n \"example\": \"p7343097242684\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"sede\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"nulla33\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"voluptate_06\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"icon\": \"\"\n },\n \"batchId\": \"\"\n },\n {\n \"body\": {\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"rootWorkspace\": \"\",\n \"typeId\": {\n \"title\": \"Component Type Id\",\n \"description\": \"Component types are drawn from the type-hierarchy defined by the workspace's metamodel.\",\n \"example\": \"p7343097242684\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"voluptate4\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"icon\": \"\"\n },\n \"batchId\": \"\"\n }\n ],\n \"upsert\": [\n {\n \"uniqueBy\": [\n \"\",\n \"\"\n ],\n \"body\": {\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"rootWorkspace\": \"\",\n \"typeId\": {\n \"title\": \"Component Type Id\",\n \"description\": \"Component types are drawn from the type-hierarchy defined by the workspace's metamodel.\",\n \"example\": \"p7343097242684\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"est_0\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"icon\": \"\"\n },\n \"batchId\": \"\"\n },\n {\n \"uniqueBy\": [\n \"\",\n \"\"\n ],\n \"body\": {\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"rootWorkspace\": \"\",\n \"typeId\": {\n \"title\": \"Component Type Id\",\n \"description\": \"Component types are drawn from the type-hierarchy defined by the workspace's metamodel.\",\n \"example\": \"p7343097242684\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"sint_b72\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"nostrud_1\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"qui133\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"icon\": \"\"\n },\n \"batchId\": \"\"\n }\n ],\n \"update\": [\n {\n \"id\": \"\",\n \"ifVersionMatch\": \"\",\n \"body\": {\n \"customFields\": {\n \"veniam_6_\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"deseruntbb\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"description\": {\n \"nullable\": true\n },\n \"color\": \"\",\n \"shape\": \"\",\n \"icon\": \"\",\n \"image\": \"\",\n \"parent\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"ifVersionMatch\": \"\",\n \"body\": {\n \"customFields\": {\n \"qui8\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"commodo_a0\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"description\": {\n \"nullable\": true\n },\n \"color\": \"\",\n \"shape\": \"\",\n \"icon\": \"\",\n \"image\": \"\",\n \"parent\": \"\"\n }\n }\n ],\n \"delete\": [\n {\n \"id\": \"\",\n \"match\": {\n \"customFields\": {\n \"sit53c\": \"\"\n },\n \"rootWorkspace\": \"\",\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"componentKey\": \"\",\n \"typeId\": {\n \"title\": \"Component Type Id\",\n \"description\": \"Component types are drawn from the type-hierarchy defined by the workspace's metamodel.\",\n \"example\": \"p7343097242684\"\n }\n }\n },\n {\n \"id\": \"\",\n \"match\": {\n \"customFields\": {\n \"pariatur_f7\": \"\"\n },\n \"rootWorkspace\": \"\",\n \"name\": {\n \"title\": \"Component Name\",\n \"description\": \"The name of the component.\",\n \"example\": \"My Component\"\n },\n \"componentKey\": \"\",\n \"typeId\": {\n \"title\": \"Component Type Id\",\n \"description\": \"Component types are drawn from the type-hierarchy defined by the workspace's metamodel.\",\n \"example\": \"p7343097242684\"\n }\n }\n }\n ]\n },\n \"references\": {\n \"create\": [\n {\n \"body\": {\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"customFields\": {\n \"quis939\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"displayText\": \"\",\n \"description\": {\n \"nullable\": true\n }\n },\n \"batchId\": \"\"\n },\n {\n \"body\": {\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"customFields\": {\n \"aliquip261\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"ipsum6\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"displayText\": \"\",\n \"description\": {\n \"nullable\": true\n }\n },\n \"batchId\": \"\"\n }\n ],\n \"upsert\": [\n {\n \"uniqueBy\": [\n \"\",\n \"\"\n ],\n \"body\": {\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"customFields\": {\n \"cillum_c\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"displayText\": \"\",\n \"description\": {\n \"nullable\": true\n }\n },\n \"batchId\": \"\"\n },\n {\n \"uniqueBy\": [\n \"\",\n \"\"\n ],\n \"body\": {\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"customFields\": {\n \"nulla_078\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"displayText\": \"\",\n \"description\": {\n \"nullable\": true\n }\n },\n \"batchId\": \"\"\n }\n ],\n \"update\": [\n {\n \"id\": \"\",\n \"ifVersionMatch\": \"\",\n \"body\": {\n \"customFields\": {\n \"sit_4a5\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"Lorem_2\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"displayText\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"source\": \"\",\n \"target\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"ifVersionMatch\": \"\",\n \"body\": {\n \"customFields\": {\n \"commodo_6c\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"fugiatce_\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"dolor8ae\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"ullamcoc\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n }\n },\n \"displayText\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"source\": \"\",\n \"target\": \"\"\n }\n }\n ],\n \"delete\": [\n {\n \"id\": \"\",\n \"match\": {\n \"customFields\": {\n \"labore_0e_\": \"\",\n \"id_5\": \"\",\n \"est_c3\": \"\",\n \"id_fd6\": \"\"\n },\n \"rootWorkspace\": \"\",\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"targetWorkspace\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"match\": {\n \"customFields\": {\n \"Excepteur408\": \"\"\n },\n \"rootWorkspace\": \"\",\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"targetWorkspace\": \"\"\n }\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Reports", "description": "", "item": [ { "id": "4e66149f-ee28-4494-b78d-c943a1856f3e", "name": "Report definition", "request": { "name": "Report definition", "description": { "content": "Get the overview of a report associated with a given Ardoq Identifier. The overview contains the name, description, and other _meta_ information about the report. The overview does not contain the actual report data. ", "type": "text/plain" }, "url": { "path": [ "api", "v2", "reports", ":id" ], "host": [ "{{ARDOQ_API_HOST}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) An Ardoq identifier (OID)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0a6089ec-8b2d-42de-9e0a-bd03425a6c1d", "name": "Run Report (Objects)", "request": { "name": "Run Report (Objects)", "description": { "content": "Run a report associated with a given Ardoq Identifier and return the results in object format (list of objects).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "reports", ":id", "run", "objects" ], "host": [ "{{ARDOQ_API_HOST}}" ], "query": [ { "disabled": true, "description": { "content": "This parameter is used to manage the format of the objects keys. The api will default to 'label'", "type": "text/plain" }, "key": "keyFormat", "value": "key" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) An Ardoq identifier (OID)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "304118ba-3b86-45e9-9896-1334a6821095", "name": "List Report definitions", "request": { "name": "List Report definitions", "description": { "content": "List all reports. Query parameters can be used to retrieve a subset of the reports. All included query parameters are interpreted as forming a logical **conjunction**, meaning that only reports that satisfy every property will be returned. ", "type": "text/plain" }, "url": { "path": [ "api", "v2", "reports" ], "host": [ "{{ARDOQ_API_HOST}}" ], "query": [ { "disabled": true, "description": { "content": "The name of the report.", "type": "text/plain" }, "key": "name", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "08d76174-1483-4afd-9f5d-a384be51be1d", "name": "Run Report (Tabular)", "request": { "name": "Run Report (Tabular)", "description": { "content": "Run a report associated with a given Ardoq Identifier and return the results in tabular format (list of lists).", "type": "text/plain" }, "url": { "path": [ "api", "v2", "reports", ":id", "run", "tabular" ], "host": [ "{{ARDOQ_API_HOST}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) An Ardoq identifier (OID)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "pm.request.headers.add({ key: 'X-org', value: pm.variables.get(\"ARDOQ_ORG_LABEL\") })" ] } } ], "variable": [ { "key": "ARDOQ_API_HOST", "value": "https://app.ardoq.com", "type": "string" }, { "key": "ARDOQ_ORG_LABEL", "value": "FIXME", "type": "string" }, { "key": "ARDOQ_API_TOKEN", "value": "FIXME", "type": "string" } ], "info": { "_postman_id": "5961e1f8-48f8-45da-81c6-9ace1432817d", "name": "Ardoq Public API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Resources for writing custom integrations.\n\nContact Support:\n Email: support@ardoq.com", "type": "text/plain" } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ARDOQ_API_TOKEN}}", "type": "string" } ] } }