{ "item": [ { "name": "Misc", "description": "", "item": [ { "id": "d5f36306-050e-437e-82fe-b1b73c598967", "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": "e2003bb5-1828-4f98-b221-fe23a8dbfcab", "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": "a7baf3d6-ee46-4cf8-93f4-62d9714c177f", "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 \"Excepteur_99\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"Lorem_1\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"nostrud_a\": {\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": "aafcb3b4-d650-4518-8e99-62d10213d940", "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 \"dolor7\": {\n \"customFields\": {\n \"proidentd8\": \"\",\n \"irure_07f\": \"\",\n \"ipsum_cdc\": \"\",\n \"Lorem_7e\": \"\"\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 \"cupidatat7\": {\n \"customFields\": {\n \"commodo_074\": \"\",\n \"Utc3\": \"\",\n \"velit_7ab\": \"\"\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\": \"p86573295058\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"anim_2\": {\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\": \"p86573295058\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"exercitation_4\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"in_8d4\": {\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\": \"p86573295058\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"esse_73\": {\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\": \"p86573295058\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"incididunt_a\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"ullamco_56\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"incididunt_1e\": {\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 \"nulla4\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"nostrud3e\": {\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 \"consectetur9c3\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"Uta\": {\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 \"aliquacaf\": \"\",\n \"mollit_9b1\": \"\"\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\": \"p86573295058\"\n }\n }\n },\n {\n \"id\": \"\",\n \"match\": {\n \"customFields\": {\n \"fugiata\": \"\",\n \"ut9a\": \"\"\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\": \"p86573295058\"\n }\n }\n }\n ]\n },\n \"references\": {\n \"create\": [\n {\n \"body\": {\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"customFields\": {\n \"culpa740\": {\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 \"ullamco_85\": {\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 \"dolore75\": {\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 \"utb4\": {\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 \"in_2ed\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"occaecatb\": {\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 \"magna3e\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"fugiat6\": {\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 \"magna49\": \"\"\n },\n \"rootWorkspace\": \"\",\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"targetWorkspace\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"match\": {\n \"customFields\": {\n \"exercitationb\": \"\",\n \"exercitation9_\": \"\"\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": "754f6bf6-3c86-4866-afa2-dce1ea8ae3b7", "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": "00855831-f2be-4dbd-88e0-221013739d8e", "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": "8e2890be-0743-481f-863c-2d2a52b6bc94", "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 \"non_959\": {\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": "3ae3c98b-5f7f-4ed6-906c-7a2686105c4c", "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": "9191713f-6196-46fb-a832-c63e58b0842b", "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": "0da03697-085f-4a36-a5db-b607016099f4", "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": "73dc9129-40f4-40c6-9229-f4d0293f90e5", "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": "072f8c4e-3834-4a22-9ec1-f7b7ef4fc7b6", "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 \"sint_40\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"nostrud31\": {\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": "32e5dc3f-6e51-4825-ace7-45668fcadecd", "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 \"dolor7\": {\n \"customFields\": {\n \"proidentd8\": \"\",\n \"irure_07f\": \"\",\n \"ipsum_cdc\": \"\",\n \"Lorem_7e\": \"\"\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 \"cupidatat7\": {\n \"customFields\": {\n \"commodo_074\": \"\",\n \"Utc3\": \"\",\n \"velit_7ab\": \"\"\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\": \"p86573295058\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"anim_2\": {\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\": \"p86573295058\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"exercitation_4\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"in_8d4\": {\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\": \"p86573295058\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"esse_73\": {\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\": \"p86573295058\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"incididunt_a\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"ullamco_56\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"incididunt_1e\": {\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 \"nulla4\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"nostrud3e\": {\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 \"consectetur9c3\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"Uta\": {\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 \"aliquacaf\": \"\",\n \"mollit_9b1\": \"\"\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\": \"p86573295058\"\n }\n }\n },\n {\n \"id\": \"\",\n \"match\": {\n \"customFields\": {\n \"fugiata\": \"\",\n \"ut9a\": \"\"\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\": \"p86573295058\"\n }\n }\n }\n ]\n },\n \"references\": {\n \"create\": [\n {\n \"body\": {\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"customFields\": {\n \"culpa740\": {\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 \"ullamco_85\": {\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 \"dolore75\": {\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 \"utb4\": {\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 \"in_2ed\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"occaecatb\": {\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 \"magna3e\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"fugiat6\": {\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 \"magna49\": \"\"\n },\n \"rootWorkspace\": \"\",\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"targetWorkspace\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"match\": {\n \"customFields\": {\n \"exercitationb\": \"\",\n \"exercitation9_\": \"\"\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": "fed64f50-687a-4f10-9e72-00953bd10f80", "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": "9712a517-6e56-444f-8668-3449540a37a3", "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\": \"p86573295058\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"velit2ec\": {\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": "d1cb0dd3-232e-43f1-a58c-0ea8261484ed", "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": "f09b7c67-5893-490b-9981-f8ffda0d5f64", "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": "56108f9b-e9ca-401f-a579-41c1c7815d71", "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": "93c19ae1-1ac9-43b0-88a9-3ce0852092d8", "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 \"dolor7\": {\n \"customFields\": {\n \"proidentd8\": \"\",\n \"irure_07f\": \"\",\n \"ipsum_cdc\": \"\",\n \"Lorem_7e\": \"\"\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 \"cupidatat7\": {\n \"customFields\": {\n \"commodo_074\": \"\",\n \"Utc3\": \"\",\n \"velit_7ab\": \"\"\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\": \"p86573295058\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"anim_2\": {\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\": \"p86573295058\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"exercitation_4\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"in_8d4\": {\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\": \"p86573295058\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"esse_73\": {\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\": \"p86573295058\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"incididunt_a\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"ullamco_56\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"incididunt_1e\": {\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 \"nulla4\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"nostrud3e\": {\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 \"consectetur9c3\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"Uta\": {\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 \"aliquacaf\": \"\",\n \"mollit_9b1\": \"\"\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\": \"p86573295058\"\n }\n }\n },\n {\n \"id\": \"\",\n \"match\": {\n \"customFields\": {\n \"fugiata\": \"\",\n \"ut9a\": \"\"\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\": \"p86573295058\"\n }\n }\n }\n ]\n },\n \"references\": {\n \"create\": [\n {\n \"body\": {\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"customFields\": {\n \"culpa740\": {\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 \"ullamco_85\": {\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 \"dolore75\": {\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 \"utb4\": {\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 \"in_2ed\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"occaecatb\": {\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 \"magna3e\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"fugiat6\": {\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 \"magna49\": \"\"\n },\n \"rootWorkspace\": \"\",\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"targetWorkspace\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"match\": {\n \"customFields\": {\n \"exercitationb\": \"\",\n \"exercitation9_\": \"\"\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": "66b53c08-1b37-4050-860a-3a19bea0c0c2", "name": "Expand Batch", "request": { "name": "Expand Batch", "description": { "content": "Expand a batch request, but do not execute it. Useful for debugging.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "batch", "expand" ], "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 \"dolor7\": {\n \"customFields\": {\n \"proidentd8\": \"\",\n \"irure_07f\": \"\",\n \"ipsum_cdc\": \"\",\n \"Lorem_7e\": \"\"\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 \"cupidatat7\": {\n \"customFields\": {\n \"commodo_074\": \"\",\n \"Utc3\": \"\",\n \"velit_7ab\": \"\"\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\": \"p86573295058\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"anim_2\": {\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\": \"p86573295058\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"exercitation_4\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"in_8d4\": {\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\": \"p86573295058\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"esse_73\": {\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\": \"p86573295058\"\n },\n \"shape\": \"\",\n \"image\": \"\",\n \"parent\": \"\",\n \"color\": \"\",\n \"description\": {\n \"nullable\": true\n },\n \"customFields\": {\n \"incididunt_a\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"ullamco_56\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"incididunt_1e\": {\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 \"nulla4\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"nostrud3e\": {\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 \"consectetur9c3\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"Uta\": {\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 \"aliquacaf\": \"\",\n \"mollit_9b1\": \"\"\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\": \"p86573295058\"\n }\n }\n },\n {\n \"id\": \"\",\n \"match\": {\n \"customFields\": {\n \"fugiata\": \"\",\n \"ut9a\": \"\"\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\": \"p86573295058\"\n }\n }\n }\n ]\n },\n \"references\": {\n \"create\": [\n {\n \"body\": {\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"customFields\": {\n \"culpa740\": {\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 \"ullamco_85\": {\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 \"dolore75\": {\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 \"utb4\": {\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 \"in_2ed\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"occaecatb\": {\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 \"magna3e\": {\n \"title\": \"Value\",\n \"description\": \"The value of a custom field.\"\n },\n \"fugiat6\": {\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 \"magna49\": \"\"\n },\n \"rootWorkspace\": \"\",\n \"source\": \"\",\n \"target\": \"\",\n \"type\": \"\",\n \"targetWorkspace\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"match\": {\n \"customFields\": {\n \"exercitationb\": \"\",\n \"exercitation9_\": \"\"\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": "9dd544de-801c-4220-80bd-345df03f4989", "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": "66c47d62-d614-40a3-811c-be76f0efe49e", "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": "label" } ], "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": "18588257-5dbe-4ccb-8d87-562a52f05641", "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": "ee6597b6-9674-4dd7-b076-a686182fbf78", "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": "82ef925f-a981-4d40-a95b-0431e5faa07d", "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" } ] } }