### Get References Source: https://developer.ardoq.com/api/v2/swagger Retrieves a list of references within the Ardoq system. Each reference includes details about its source, target, and associated metadata. ```APIDOC GET /api/v2/references description: Retrieves references. responses: 200: description: Success schema: type: object properties: values: type: array items: type: object properties: rootWorkspace: type: string title: Workspace ID of Reference's `source` Component description: This is a read-only field maintained by the backend to simplify workspace lookups. It is derived from the `source` attribute. A reference's `rootWorkspace` cannot be changed by modifying this attribute. example: e1d2ebb95349d8e20c631735 targetWorkspace: type: string title: Workspace ID of Reference's `target` Component description: This is a read-only field maintained by the backend to simplify workspace lookups. It is derived from the `target` attribute. A reference's `targetWorkspace` cannot be changed by modifying this attribute. example: 5973bd2550e26d5eeb05815e _meta: type: object properties: created: type: string format: date-time title: Time of creation description: A Coordinated Universal Time (UTC) timestamp generated when the entity was created. example: 2025-01-31T12:19:53.898Z createdBy: type: string title: Creator ID description: The internal Ardoq identifier of the user that created the entity. example: af51f10f1e353d50568a945d lastUpdated: type: string format: date-time title: Last Updated Timestamp description: A Coordinated Universal Time (UTC) timestamp generated when the entity was last updated. example: 2025-01-31T12:20:25.218Z lastModifiedBy: type: string title: Updater ID description: The internal Ardoq identifier of the user that last modified the entity. example: 7c53e66bc17d8b106c84eca9 createdByEmail: type: string format: email title: Creator Email description: The current email address of the user that created the entity. example: creator@ardoq.com createdByName: type: string title: Creator name description: The current name of the user that created the entity. example: Mr. Ardoq lastModifiedByEmail: type: string format: email title: Updater Email description: The current email address of the user that last modified the entity. example: updater@ardoq.com lastModifiedByName: type: string title: Updater Name description: The current name of the user that last modified the entity. example: Ms. Ardoq required: [created, createdBy, createdByEmail, createdByName, lastModifiedBy, lastModifiedByEmail, lastModifiedByName, lastUpdated] title: Metadata description: Metadata about the entity. source: type: string title: ID of Source Component description: ID of the reference's source component. example: 983371bb501b1ff068d19a0d type: type: integer format: int64 title: Type ID of Reference description: Required type ID for the reference. This ID must be a valid type defined by the model that is used by the `rootWorkspace`. example: 2 _id: type: string title: Reference ID description: The unique Ardoq identifier (oid) of the reference. example: 156296fda0dc801866510d44 target: type: string title: ID of Target Component description: ID of the reference's target component. example: 49e30fed029764b163c161bf _version: type: integer format: int64 title: Reference Version example: 1 description: Reference versions are used to resolve contention between different users editing the same entity simultaneously. This value should not be modified. description: type: string x-nullable: true title: Reference Description description: Optional description for your reference example: This is a reference description. displayText: type: string x-nullable: true title: Reference Display Text description: Optional display label for your reference in views such as the block diagram. example: Depends on ``` -------------------------------- ### Get Workspaces API Source: https://developer.ardoq.com/api/v2/swagger Retrieves a list of workspaces. The response includes metadata for each workspace, such as creation time, creator ID, last updated time, and the user who last modified it. ```APIDOC GET /api/v2/workspaces Responses: 200: description: Success schema: type: object properties: values: type: array items: type: object properties: _meta: type: object properties: created: type: string format: date-time title: Time of creation description: A Coordinated Universal Time (UTC) timestamp generated when the entity was created. example: "2025-01-31T12:19:53.898Z" createdBy: type: string title: Creator ID description: The internal Ardoq identifier of the user that created the entity. example: "af51f10f1e353d50568a945d" lastUpdated: type: string format: date-time title: Last Updated Timestamp description: A Coordinated Universal Time (UTC) timestamp generated when the entity was last updated. example: "2025-01-31T12:20:25.218Z" lastModifiedBy: type: string title: Updater ID description: The internal Ardoq identifier of the user that last modified the entity. example: "af51f10f1e353d50568a945d" ``` -------------------------------- ### Ardoq Public API v2 Documentation Source: https://developer.ardoq.com/api/v2/swagger This section details the Ardoq Public API v2, including information on creating components, supported data formats, and contact information for support. ```APIDOC Ardoq Public API v2 Resources for writing custom integrations. Version: 2025-01-31-baaebb838 Terms of Service: https://www.ardoq.com/terms Contact: support@ardoq.com License: private (https://www.ardoq.com/terms) Host: app.ardoq.com Consumes: application/json Tags: Components Component Object: Properties: icon: (string, optional) - Icon is a style attribute used by the front-end to display the component icon in views like the block diagram. By default this will use the icon defined by the component-type, but can be overriden by setting it explicitly per-component. A list of valid values for this attribute should be found by inspecting the style drop-down in the front-end. Example: "road" Required Properties for Component: - name - rootWorkspace - typeId Create Component: Summary: Create a component Description: Create a component Public v2: true Deprecated: false ``` -------------------------------- ### Get User Information (Me) Source: https://developer.ardoq.com/api/v2/swagger Retrieves basic information about the authenticated user and their organization. This endpoint is useful for testing connection and identifying the current user context. ```APIDOC GET /api/v2/me summary: Me description: A simple endpoint for testing your connection to the Ardoq server. responses: 200: description: Success schema: type: object properties: org: type: object properties: name: type: string title: Org name example: My Org description: The name of the organization (org) associated with the request. label: type: string title: Org label example: myorg description: The label of the organization (org) associated with the request. required: [name, label] title: Org user: type: object properties: email: type: string title: email example: me@myorg.com description: The email of the user associated with the request. required: [email] title: User description: A small amount of data that identifies the user making the request. title: body ``` -------------------------------- ### Batch Create Components Source: https://developer.ardoq.com/api/v2/swagger Creates multiple components in a batch operation. Allows specifying root workspace, shape, and image for components. Returns created components with their IDs and bodies. ```APIDOC /api/v2/batch POST: responses: 200: description: Success schema: type: object properties: components: type: object properties: created: type: array items: type: object properties: id: type: string title: Id description: The Ardoq identifier (oid) of the entity body: type: object properties: rootWorkspace: type: string title: Component's Workspace ID description: The Ardoq identifier (oid) of the workspace that the component belongs to. example: 94853cafda12fddbb3b1090b shape: type: string x-nullable: true title: Component Shape description: Shape is a style attribute used by the front-end to display the component shape in views like the block diagram. By default this will use the shape defined by the component-type, but can be overriden by setting it explicitly per-component. A list of valid values for this attribute should be found by inspecting the style drop-down in the front-end. example: terminal image: type: string x-nullable: true title: Component Image description: Image is a style attribute used by the front-end to display the component image in views like the block diagram. By default this will use the image defined by the component-type, but can be overriden by setting it explicitly per-component. example: /api/attachment/workspace/123456789abcdef1 tags: - Components x-public-v2: true summary: Batch Create Components description: Creates components in batch. ``` -------------------------------- ### Ardoq API v2 Get Reference Source: https://developer.ardoq.com/api/v2/swagger Retrieves a specific reference by its ID. This endpoint provides details about the reference, including its source and target components, type, and metadata. ```APIDOC GET /api/v2/references/{id} Description: Retrieves a specific reference. Parameters: - id (string): The unique Ardoq identifier (oid) of the reference. Responses: 200 (Success): schema: object properties: _id (string): The unique Ardoq identifier (oid) of the reference. source (string): ID of the reference's source component. target (string): ID of the reference's target component. type (integer): Required type ID for the reference. Must be a valid type defined by the model used by the `rootWorkspace`. rootWorkspace (string): Workspace ID of the reference's `source` Component. Read-only. targetWorkspace (string): Workspace ID of the reference's `target` Component. Read-only. _version (integer): Reference versions used to resolve contention. _meta (object): Metadata about the entity. properties: created (string, format: date-time): Time of creation (UTC). createdBy (string): The internal Ardoq identifier of the user that created the entity. lastUpdated (string, format: date-time): Last updated timestamp (UTC). lastModifiedBy (string): The internal Ardoq identifier of the user that last modified the entity. createdByEmail (string, format: email): The current email address of the user that created the entity. createdByName (string): The current name of the user that created the entity. lastModifiedByEmail (string, format: email): The current email address of the user that last modified the entity. lastModifiedByName (string): The current name of the user that last modified the entity. example: { "_id": "156296fda0dc801866510d44", "source": "983371bb501b1ff068d19a0d", "type": 2, "target": "49e30fed029764b163c161bf", "rootWorkspace": "e1d2ebb95349d8e20c631735", "targetWorkspace": "5973bd2550e26d5eeb05815e", "_version": 1, "_meta": { "created": "2025-01-31T12:19:53.898Z", "createdBy": "af51f10f1e353d50568a945d", "lastUpdated": "2025-01-31T12:20:25.218Z", "lastModifiedBy": "7c53e66bc17d8b106c84eca9", "createdByEmail": "creator@ardoq.com", "createdByName": "Mr. Ardoq", "lastModifiedByEmail": "updater@ardoq.com", "lastModifiedByName": "Ms. Ardoq" } } Tags: [References] ``` -------------------------------- ### Create Reference Source: https://developer.ardoq.com/api/v2/swagger Creates a new reference in Ardoq. The response includes metadata about the creation, such as timestamps and user IDs. ```APIDOC POST /references Request Body Schema: Reference: _id (string) _meta (object) _version (string) customFields (object) source (string) target (string) type (string) Response Schema (201 Created): Success: rootWorkspace (string): Workspace ID of Reference's `source` Component. targetWorkspace (string): Workspace ID of Reference's `target` Component. _meta (object): created (string, format: date-time) createdBy (string) lastUpdated (string, format: date-time) lastModifiedBy (string) createdByEmail (string, format: email) createdByName (string) lastModifiedByEmail (string, format: email) ``` -------------------------------- ### Get Ardoq Component Source: https://developer.ardoq.com/api/v2/swagger Retrieves a specific component from Ardoq using its unique Ardoq Identifier (OID). This operation returns the full component object, including all its properties and metadata. ```APIDOC GET /components/{id} Summary: Get a component Description: Get a component associated with a given Ardoq Identifier. Parameters: - in: path name: id description: An Ardoq identifier (OID) type: string required: true x-example: 633aba0363c9c04370cf8135 Tags: - Components x-public-v2: true Deprecated: false ``` -------------------------------- ### Create Component Source: https://developer.ardoq.com/api/v2/swagger Creates a new component within Ardoq. Requires specifying the component's name and its root workspace. Optional parameters include shape, image, and parent. ```APIDOC POST /components Request Body: rootWorkspace (string, required): The Ardoq identifier (oid) of the workspace that the component belongs to. name (string, required): The name of the component. shape (string, optional): Shape is a style attribute used by the front-end to display the component shape in views like the block diagram. By default this will use the shape defined by the component-type, but can be overriden by setting it explicitly per-component. image (string, optional): Image is a style attribute used by the front-end to display the component image in views like the block diagram. By default this will use the image defined by the component-type, but can be overriden by setting it explicitly per-component. parent (string, optional): The Ardoq identifier (oid) of the parent component. Responses: 201 (Success): schema: { type: "object", properties: { rootWorkspace: { type: "string", title: "Component's Workspace ID" }, shape: { type: "string", title: "Component Shape" }, image: { type: "string", title: "Component Image" }, parent: { type: "string", title: "Parent ID" }, name: { type: "string", title: "Component Name" }, _meta: { type: "object", properties: { created: { type: "string", format: "date-time", title: "Time of creation" }, createdBy: { type: "string", title: "Creator ID" }, lastUpdated: { type: "string", format: "date-time", title: "Last Updated Timestamp" }, lastModifiedBy: { type: "string", title: "Updater ID" }, createdByEmail: { type: "string", format: "email", title: "Creator Email" }, createdByName: { type: "string", title: "Creator name" }, lastModifiedByEmail: { type: "string", format: "email", title: "Updater Email" }, lastModifiedByName: { type: "string", title: "Updater Name" } } } } } Tags: Components ``` -------------------------------- ### Ardoq Component Structure and Creation Parameters Source: https://developer.ardoq.com/api/v2/swagger Defines the structure of a component returned by the Ardoq API and the parameters required for creating a new component. This includes essential fields like _id, _meta, _version, name, rootWorkspace, and typeId, as well as optional styling attributes and custom fields. ```APIDOC Component Returned by Ardoq: _id: string (Component ID) _meta: object (Metadata about the entity) required: ["created", "createdBy", "createdByEmail", "createdByName", "lastModifiedBy", "lastModifiedByEmail", "lastModifiedByName", "lastUpdated"] _version: integer (Version) customFields: object (Custom Fields) name: string (Component Name) rootWorkspace: string (Component's Workspace ID) typeId: string (Component Type Id) type: string (Component Type Name) componentKey: string (Ardoq ID) color: string (Component Color, optional) description: string (Component Description, optional) icon: string (Component Icon, optional) Create Component Parameters: body: object rootWorkspace: string (Component's Workspace ID) shape: string (Component Shape, optional) image: string (Component Image, optional) parent: string (Parent ID, optional) name: string (Component Name) typeId: string (Component Type Id) color: string (Component Color, optional) description: string (Component Description, optional) customFields: object (Custom Fields) ``` -------------------------------- ### Ardoq API v2: Reference Operations Source: https://developer.ardoq.com/api/v2/swagger Details the structure for creating and updating references in Ardoq. This includes specifying source and target components, reference type, display text, description, and associated metadata. It supports batch creation of references. ```APIDOC References: type: object properties: created: type: array items: type: object properties: id: type: string title: Id description: The Ardoq identifier (oid) of the entity body: type: object properties: rootWorkspace: type: string title: Workspace ID of Reference's `source` Component description: This is a read-only field maintained by the backend to simplify workspace lookups. It is derived from the `source` attribute. A reference's `rootWorkspace` cannot be changed by modifying this attribute. example: "e1d2ebb95349d8e20c631735" targetWorkspace: type: string title: Workspace ID of Reference's `target` Component description: This is a read-only field maintained by the backend to simplify workspace lookups. It is derived from the `target` attribute. A reference's `targetWorkspace` cannot be changed by modifying this attribute. example: "5973bd2550e26d5eeb05815e" _meta: type: object properties: created: { type: string, format: date-time, title: Time of creation, description: A Coordinated Universal Time (UTC) timestamp generated when the entity was created., example: "2025-01-31T12:19:53.898Z" } createdBy: { type: string, title: Creator ID, description: The internal Ardoq identifier of the user that created the entity., example: "af51f10f1e353d50568a945d" } lastUpdated: { type: string, format: date-time, title: Last Updated Timestamp, description: A Coordinated Universal Time (UTC) timestamp generated when the entity was last updated., example: "2025-01-31T12:20:25.218Z" } lastModifiedBy: { type: string, title: Updater ID, description: The internal Ardoq identifier of the user that last modified the entity., example: "7c53e66bc17d8b106c84eca9" } createdByEmail: { type: string, format: email, title: Creator Email, description: The current email address of the user that created the entity., example: "creator@ardoq.com" } createdByName: { type: string, title: Creator name, description: The current name of the user that created the entity., example: "Mr. Ardoq" } lastModifiedByEmail: { type: string, format: email, title: Updater Email, description: The current email address of the user that last modified the entity., example: "updater@ardoq.com" } lastModifiedByName: { type: string, title: Updater Name, description: The current name of the user that last modified the entity., example: "Ms. Ardoq" } required: [ created, createdBy, createdByEmail, createdByName, lastModifiedBy, lastModifiedByEmail, lastModifiedByName, lastUpdated ] title: Metadata description: Metadata about the entity. source: type: string title: ID of Source Component description: ID of the reference's source component. example: "983371bb501b1ff068d19a0d" type: type: integer format: int64 title: Type ID of Reference description: Required type ID for the reference. This ID must be a valid type defined by the model that is used by the `rootWorkspace`. example: 2 _id: type: string title: Reference ID description: The unique Ardoq identifier (oid) of the reference. example: "156296fda0dc801866510d44" target: type: string title: ID of Target Component description: ID of the reference's target component. example: "49e30fed029764b163c161bf" _version: type: integer format: int64 title: Reference Version example: 1 description: Reference versions are used to resolve contention between different users editing the same entity simultaneously. This value should not be modified. description: type: string x-nullable: true title: Reference Description description: Optional description for your reference example: "This is a reference description." displayText: type: string x-nullable: true title: Reference Display Text description: Optional display label for your reference in views such as the block diagram. example: "Depends on" customFields: type: object additionalProperties: { title: Value, description: T required: [ _id, _meta, _version, customFields, name, rootWorkspace, typeId ] title: ardoq.api.public.v2.specs.batch.components.processed/result-with-id-and-entity title: Component results ``` -------------------------------- ### Get Report Details Source: https://developer.ardoq.com/api/v2/swagger Retrieves the details of a specific report by its ID. This includes the report's version, name, data source type, columns, description, and metadata such as creation and last updated timestamps. ```APIDOC GET /api/v2/reports/{id} Parameters: - in: path name: id description: The unique Ardoq identifier (oid) of the report. type: string required: true x-example: "63ea1a02bbed2e0001a19a9c" Responses: 200: description: Success schema: type: object properties: _id: type: string title: Report Id description: The unique Ardoq identifier (oid) of the report. example: "63ea1a02bbed2e0001a19a9c" _version: type: integer format: int64 minimum: 0 title: Version example: 1 description: The current version of the report. Versions are used to resolve contention between different users editing the same entity simultaneously. name: type: string x-allOf: - type: string - {} title: Name description: Name of report and stored query example: "The best of reports" datasource: enum: ["graphSearch", "advancedSearch"] type: string title: Data Source description: The type of data source backing the report columns: type: array items: type: object properties: label: type: string title: Label description: The column name as displayed in the Ardoq UI. example: "Application" key: title: Key type: string description: The api name of the custom field or built-in property (or custom gremlin result) example: "application" required: ["label", "key"] title: Column description: Information out a single column in a report title: Columns description: Information about the columns in a report description: type: string x-nullable: true title: Description description: An optional description of the report _meta: type: object properties: created: type: string format: date-time title: Time of creation description: A Coordinated Universal Time (UTC) timestamp generated when the entity was created. example: "2025-01-31T12:19:53.898Z" createdBy: type: string title: Creator ID description: The internal Ardoq identifier of the user that created the entity. example: "af51f10f1e353d50568a945d" lastUpdated: type: string format: date-time title: Last Updated Timestamp description: A Coordinated Universal Time (UTC) timestamp generated when the entity was last updated. example: "2025-01-31T12:20:25.218Z" lastModifiedBy: type: string title: Updater ID description: The internal Ardoq identifier of the user that last updated the entity. example: "af51f10f1e353d50568a945d" ``` -------------------------------- ### Ardoq API v2: Get Component Details Source: https://developer.ardoq.com/api/v2/swagger This API endpoint retrieves detailed information about a specific component. It returns attributes such as the component's workspace ID, shape, image, parent component ID, and metadata including creation and modification details. ```APIDOC GET /api/v2/components/{id} Responses: 200: description: "Success" schema: type: object properties: rootWorkspace: type: string title: "Component's Workspace ID" description: "The Ardoq identifier (oid) of the workspace that the component belongs to." example: "94853cafda12fddbb3b1090b" shape: type: string x-nullable: true title: "Component Shape" description: "Shape is a style attribute used by the front-end to display the component shape in views like the block diagram. By default this will use the shape defined by the component-type, but can be overriden by setting it explicitly per-component. A list of valid values for this attribute should be found by inspecting the style drop-down in the front-end." example: "terminal" image: type: string x-nullable: true title: "Component Image" description: "Image is a style attribute used by the front-end to display the component image in views like the block diagram. By default this will use the image defined by the component-type, but can be overriden by setting it explicitly per-component." example: "/api/attachment/workspace/123456789abcdef123456789/index.jpg" parent: title: "Parent ID" type: string x-nullable: true description: "The Ardoq identifier (oid) of ``` -------------------------------- ### List Workspaces Source: https://developer.ardoq.com/api/v2/swagger Retrieves a list of workspaces. Supports filtering by name and component model. Filters are combined with a logical AND. Includes pagination details and links to next pages. ```APIDOC /api/v2/workspaces GET: responses: 200: description: Success schema: type: object properties: values: type: array items: type: object properties: _id: type: string title: Workspace ID description: Unique component `id`. Required and read-only. example: 02d85ec9e4d1a9b9d6e380e4 _version: type: integer format: int64 minimum: 0 title: Workspace Version example: 1 description: Versions are used to resolve contention between different users editing the same entity simultaneously. name: type: string title: Workspace Name description: The name of your workspace. Required. example: My First Workspace description: type: string x-nullable: true title: Workspace Description example: My favorite workspace description: Describe your workspace! views: type: array items: type: string x-nullable: true title: Views example: ["blockDiagram","tableView"] description: The views that are configured as default tabs at the top of the workspace. startView: type: string x-nullable: true title: Start view example: blockDiagram description: The default view that will be shown when opening the workspace. workspaceKey: type: string title: Workspace Key example: ABC description: A unique human-readible workspace identifier. _meta: type: object properties: created: type: string format: date-time title: Created description: The date and time that the entity was created. example: 2023-01-01T10:00:00Z createdBy: type: string title: Creator description: The Ardoq identifier (oid) of the user that created the entity. example: 5c53e66bc17d8b106c84eca9 createdByEmail: type: string format: email title: Creator Email description: The current email address of the user that created the entity. example: creator@ardoq.com createdByName: type: string x-allOf: - type: string - type: {} title: Creator name description: The current name of the user that created the entity. example: Mr. Ardoq lastModifiedByEmail: type: string format: email title: Updater Email description: The current email address of the user that last modified the entity. example: updater@ardoq.com lastModifiedByName: type: string x-allOf: - type: string - type: {} title: Updater Name description: The current name of the user that last modified the entity. example: Ms. Ardoq required: - created - createdBy - createdByEmail - createdByName - lastModifiedBy - lastModifiedByEmail - lastModifiedByName - lastUpdated title: Metadata description: Metadata about the entity. required: - _id - _meta - _version - name title: Workspace description: A Workspace Returned by Ardoq title: Paginated values _links: type: object properties: next: type: object properties: href: type: string title: href description: A URI that can be used to retrieve the next set of paginated results. required: - href title: Next description: A link to the next page in a paginated result. title: Links description: Links related to the paginated results. _meta: type: object additionalProperties: {} title: Metadata description: Metadata related to the paginated response. required: - values - _links title: Paginated response description: The Paginated Response parameters: - in: query name: name description: The name of the entity. type: string required: false x-example: My entity - in: query name: componentModel description: The ardoq identifier of the model that the workspace has. type: string required: false x-example: 4b131856bb51f7fa1aadjace0db tags: - Workspaces x-public-v2: true summary: List Workspaces description: 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. ``` -------------------------------- ### Ardoq API v2 Workspace Documentation Source: https://developer.ardoq.com/api/v2/swagger This section details the structure of a Workspace object returned by the Ardoq API v2. It includes fields for the workspace ID, version, name, description, default views, and workspace key, along with comprehensive metadata about its creation and last modification. ```APIDOC GET /api/v2/workspaces/{id} Summary: Get a workspace Description: Get a workspace associated with a given Ardoq Identifier. Parameters: - in: path name: id description: An Ardoq identifier (OID) type: string required: true x-example: "633aba0363c9c04370cf8135" Tags: - Workspaces x-public-v2: true Responses: 200: description: Success schema: type: object properties: _id: { type: string, title: Workspace ID, description: Unique component `id`. Required and read-only., example: "02d85ec9e4d1a9b9d6e380e4" } _meta: { type: object, properties: { created: { type: string, format: date-time, title: Time of creation, description: A Coordinated Universal Time (UTC) timestamp generated when the entity was created., example: "2025-01-31T12:19:53.898Z" }, createdBy: { type: string, title: Creator ID, description: The internal Ardoq identifier of the user that created the entity., example: "af51f10f1e353d50568a945d" }, createdByEmail: { type: string, format: email, title: Creator Email, description: The current email address of the user that created the entity., example: "creator@ardoq.com" }, createdByName: { type: string, title: Creator name, description: The current name of the user that created the entity., example: "Mr. Ardoq" }, lastUpdated: { type: string, format: date-time, title: Last Updated Timestamp, description: A Coordinated Universal Time (UTC) timestamp generated when the entity was last updated., example: "2025-01-31T12:20:25.218Z" }, lastModifiedBy: { type: string, title: Updater ID, description: The internal Ardoq identifier of the user that last modified the entity., example: "7c53e66bc17d8b106c84eca9" }, lastModifiedByEmail: { type: string, format: email, title: Updater Email, description: The current email address of the user that last modified the entity., example: "updater@ardoq.com" }, lastModifiedByName: { type: string, title: Updater Name, description: The current name of the user that last modified the entity., example: "Ms. Ardoq" } }, required: ["created", "createdBy", "createdByEmail", "createdByName", "lastModifiedBy", "lastModifiedByEmail", "lastModifiedByName", "lastUpdated"], title: Metadata, description: Metadata about the entity. } _version: { type: integer, format: int64, minimum: 0, title: Workspace Version, example: 1, description: Versions are used to resolve contention between different users editing the same entity simultaneously. } name: { type: string, title: Workspace Name, description: The name of your workspace. Required., example: "My First Workspace" } description: { type: string, x-nullable: true, title: Workspace Description, example: "My favorite workspace", description: "Describe your workspace!" } views: { type: array, items: { type: string }, x-nullable: true, title: Views, example: ["blockDiagram", "tableView"], description: "The views that are configured as default tabs at the top of the workspace." } startView: { type: string, x-nullable: true, title: Start view, example: "blockDiagram", description: "The default view that will be shown when opening the workspace." } workspaceKey: { type: string, title: Workspace Key, example: "ABC", description: "A unique human-readible workspace identifier." } required: ["_id", "_meta", "_version", "name"] title: Workspace description: A Workspace Returned by Ardoq ``` -------------------------------- ### Ardoq API v2 Workspaces Source: https://developer.ardoq.com/api/v2/swagger Endpoint for retrieving information about Ardoq workspaces. ```APIDOC GET /api/v2/workspaces/{id} summary: Workspace description: Get a workspace by its Ardoq Identifier (OID). parameters: - in: path name: id description: An Ardoq identifier (OID) type: string required: true x-example: "633aba0363c9c04370cf8135" tags: - Workspaces x-public-v2: true responses: 200: description: Success schema: type: object properties: _meta: type: object properties: created: type: string format: date-time title: Time of creation description: A Coordinated Universal Time (UTC) timestamp generated when the entity was created. example: "2025-01-31T12:19:53.898Z" createdBy: type: string title: Creator ID description: The internal Ardoq identifier of the user that created the entity. example: "af51f10f1e353d50568a945d" lastUpdated: type: string format: date-time title: Last Updated Timestamp description: A Coordinated Universal Time (UTC) timestamp generated when the entity was last updated. example: "2025-01-31T12:20:25.218Z" lastModifiedBy: type: string title: Updater ID description: The internal Ardoq identifier of the user that last modified the entity. createdByEmail: type: string format: email title: Creator Email description: The current email address of the user that created the entity. example: "creator@ardoq.com" createdByName: type: string title: Creator name description: The current name of the user that created the entity. example: "Mr. Ardoq" lastModifiedByEmail: type: string format: email title: Updater Email description: The current email address of the user that last modified the entity. example: "updater@ardoq.com" lastModifiedByName: type: string title: Updater Name description: The current name of the user that last modified the entity. example: "Ms. Ardoq" required: [created, createdBy, createdByEmail, createdByName, lastModifiedBy, lastModifiedByEmail, lastModifiedByName, lastUpdated] title: Metadata description: Metadata about the entity. ```