### POST /workflows/{workflowPath}/timerstart/{timerStartNodePath}/start

Source: https://developers.unqork.io/

Starts a timer start node in a workflow.

```APIDOC
## POST /workflows/{workflowPath}/timerstart/{timerStartNodePath}/start

### Description
Starts a timer start node in a workflow.

### Method
POST

### Endpoint
https://{host}/api/1.0/workflows/{workflowPath}/timerstart/{timerStartNodePath}/start

### Parameters
#### Path Parameters
- **workflowPath** (string) - Required - Unique workflow path
- **timerStartNodePath** (string) - Required - Unique path of a timer start node in a workflow

### Response
#### Success Response (200)
- TimerStart node successfully started

#### Error Response (default)
- **code** (integer)
- **message** (string)
```

--------------------------------

### Example Unqork API Base URI

Source: https://developers.unqork.io/

An example of the Unqork API base URI with a placeholder subdomain replaced.

```text
https://xyzfinancial.unqork.io/api/1.0
```

--------------------------------

### GET /workflows/{workflowPath}/timerstart

Source: https://developers.unqork.io/

Retrieves a list of all timer start nodes and their activity status in a workflow.

```APIDOC
## GET /workflows/{workflowPath}/timerstart

### Description
Get a list of all timer start nodes and their activity status in a workflow.

### Method
GET

### Endpoint
/api/1.0/workflows/{workflowPath}/timerstart

### Parameters
#### Path Parameters
- **workflowPath** (string) - Required - Unique workflow path

### Response
#### Success Response (200)
- **path** (string) - Workflow path
- **nodes** (array) - List of timer start nodes
- **statusCode** (integer) - Status code
```

--------------------------------

### POST /workflows/{workflowPath}/timerstart/{timerStartNodePath}

Source: https://developers.unqork.io/

Triggers a timer start node to start, creating and executing workflow submissions at the configured frequency.

```APIDOC
## POST /workflows/{workflowPath}/timerstart/{timerStartNodePath}

### Description
Trigger a timer start node to start which will create and execute workflow submissions at the configured frequency.

### Method
POST

### Endpoint
/api/1.0/workflows/{workflowPath}/timerstart/{timerStartNodePath}

### Parameters
#### Path Parameters
- **workflowPath** (string) - Required - Unique workflow path
- **timerStartNodePath** (string) - Required - Unique path of a timer start node
```

--------------------------------

### POST /workflow-execute/{workflowPath}

Source: https://developers.unqork.io/

Creates a new workflow submission using the default start node.

```APIDOC
## POST /workflow-execute/{workflowPath}

### Description
Creates a new workflow submission. Submission ID is auto-generated and returned. Workflow submission data must be provided as a JSON object.

### Method
POST

### Endpoint
https://{host}/api/1.0/workflow-execute/{workflowPath}

### Parameters
#### Path Parameters
- **workflowPath** (string) - Required - Unique workflow path

#### Request Body
- **userId** (string) - Required - Submission owner
- **data** (object) - Required - Raw data to include in submission

### Response
#### Success Response (200)
- Returns a list of submissions containing submissionId and submission details.
```

--------------------------------

### POST /workflow-execute/{workflowPath}/{stepPath}

Source: https://developers.unqork.io/

Creates a new workflow submission starting from a specific step.

```APIDOC
## POST /workflow-execute/{workflowPath}/{stepPath}

### Description
Creates a new workflow submission. Submission ID is auto-generated and returned. Workflow submission data must be provided as a JSON object.

### Method
POST

### Endpoint
https://{host}/api/1.0/workflow-execute/{workflowPath}/{stepPath}

### Parameters
#### Path Parameters
- **workflowPath** (string) - Required - Unique workflow path
- **stepPath** (string) - Required - Unique path of workflow step

#### Request Body
- **userId** (string) - Required - Submission owner
- **data** (object) - Required - Raw data to include in submission
```

--------------------------------

### Link to Unqork Resource

Source: https://developers.unqork.io/

This example shows how to construct a URL to an Unqork resource using a generated refer string.

```html
<hostname>?refer=<referString>#/display/<resource_id>
```

--------------------------------

### Get application modules

Source: https://developers.unqork.io/

Gets a list of modules tied to an application. Requires Application View authorization and OAuth2.

```APIDOC
## GET /applications/{applicationId}/modules

### Description
Gets a list of modules tied to an application.

### Method
GET

### Endpoint
https://{host}/api/1.0/applications/{applicationId}/modules

### Parameters
#### Path Parameters
- **applicationId** (string) - Required - Unique identifier for an application

#### Query Parameters
- **collation** (string) - Collation locale
- **limit** (string) - Default: 50 - Maximum number of modules to return
- **offset** (integer) - Default: 0 - Index of search results at which to begin returning results
- **sortBy** (string) - Field to sort the results by
- **sortOrder** (integer) - Order to sort results by (`1` = ascending, `-1` = decending)
- **includeShared** (boolean) - Default: false - Include modules shared to parent workspace or the environment
```

--------------------------------

### POST /workflows/{workflowPath}/timerstart/{timerStartNodePath}/run-once

Source: https://developers.unqork.io/

Triggers a timer start node to run once as a test run.

```APIDOC
## POST /workflows/{workflowPath}/timerstart/{timerStartNodePath}/run-once

### Description
Trigger a timer start node to run once (test run) which will create and execute a workflow submission a single time.

### Method
POST

### Endpoint
https://{host}/api/1.0/workflows/{workflowPath}/timerstart/{timerStartNodePath}/run-once

### Parameters
#### Path Parameters
- **workflowPath** (string) - Required - Unique workflow path
- **timerStartNodePath** (string) - Required - Unique path of a timer start node in a workflow

### Response
#### Success Response (200)
- TimerStart node successfully started for single run

#### Error Response (default)
- **code** (integer)
- **message** (string)
```

--------------------------------

### GET /applications

Source: https://developers.unqork.io/

Retrieves a list of applications accessible by the user, with options for filtering, sorting, and pagination.

```APIDOC
## GET /applications

### Description
Get a list of matching applications, will be filtered by your accessible workspaces based on permissions.

### Method
GET

### Endpoint
https://{host}/api/1.0/applications

### Query Parameters
- **limit** (integer) - Optional - Integer to limit the number of applications returned (Cannot exceed 1000). Default: 1000
- **sortBy** (string) - Optional - Field to sort found applications by. Default: "created"
- **offset** (integer) - Optional - Offset for paginated results. Default: 0
- **sortOrder** (integer) - Optional - Sort order for found applications (1 = ascending, -1 = descending). Default: 1
- **requireEntrypoint** (boolean) - Optional - Remove applications that do not have an entrypoint module/workflow. Default: true

### Responses
#### Success Response (200)
Array containing JSON objects of each found application.
#### Response Example
```json
[
  {
    "created": "string",
    "createdBy": "string",
    "dataSchemas": [
      {}
    ],
    "description": "string",
    "id": "string",
    "modified": "string",
    "modifiedBy": "string",
    "name": "string",
    "promotions": { },
    "settings": { },
    "title": "string",
    "type": "string",
    "workspaceId": "string"
  }
]
```
#### Error Response (default)
Error
```

--------------------------------

### GET /applications/{applicationId}

Source: https://developers.unqork.io/

Retrieves the details of a specific application using its unique identifier.

```APIDOC
## GET /applications/{applicationId}

### Description
Retrieves application data.

### Method
GET

### Endpoint
https://{host}/api/1.0/applications/{applicationId}

### Path Parameters
- **applicationId** (string) - Required - Unique identifier for an application.

### Responses
#### Success Response (200)
JSON describing the found application.
#### Response Example
```json
{
  "created": "string",
  "createdBy": "string",
  "dataSchemas": [
    {}
  ],
  "description": "string",
  "id": "string",
  "modified": "string",
  "modifiedBy": "string",
  "name": "string",
  "promotions": { },
  "settings": { },
  "title": "string",
  "type": "string",
  "workspaceId": "string"
}
```
#### Error Response (default)
Error
```

--------------------------------

### GET /applications/{applicationId}/modules

Source: https://developers.unqork.io/

Retrieves a list of modules associated with a specific application.

```APIDOC
## GET /applications/{applicationId}/modules

### Description
Retrieves an array of JSON objects describing the modules within an application.

### Method
GET

### Endpoint
https://{host}/api/1.0/applications/{applicationId}/modules

### Parameters
#### Path Parameters
- **applicationId** (string) - Required - Unique identifier for an application

### Response
#### Success Response (200)
- **Array** (object) - List of module objects containing id, name, title, created, and modified fields.

#### Response Example
[
  {
    "id": "string",
    "name": "string",
    "title": "string",
    "created": "string",
    "modified": "string"
  }
]
```

--------------------------------

### Get application dependencies

Source: https://developers.unqork.io/

Builds an application's module dependency tree. Requires Application View authorization and OAuth2.

```APIDOC
## GET /applications/{applicationId}/dependencies

### Description
Builds an application's module dependency tree.

### Method
GET

### Endpoint
https://{host}/api/1.0/applications/{applicationId}/dependencies

### Parameters
#### Path Parameters
- **applicationId** (string) - Required - Unique identifier for an application

### Responses
#### Success Response (200)
- JSON describing the application module dependency tree.

#### Response Example
```json
[
  {
    "moduleId": "string",
    "moduleName": "string",
    "moduleTitle": "string",
    "sharedAnywhere": true,
    "parentApplicationTitle": "string",
    "isRootDependency": true,
    "children": [
      { }
    ]
  }
]
```
```

--------------------------------

### GET /workflows/{workflowId}/submissions/{submissionId}/revisions/{revisionId}

Source: https://developers.unqork.io/

Gets a single revision for a submission with transformed data.

```APIDOC
## GET /workflows/{workflowId}/submissions/{submissionId}/revisions/{revisionId}

### Description
Gets a single revision for a submission. Revision data is transformed and returned in a specific format based on the specified transform.

### Method
GET

### Endpoint
/api/1.0/workflows/{workflowId}/submissions/{submissionId}/revisions/{revisionId}

### Parameters
#### Path Parameters
- **workflowId** (string) - Required - Unique workflow ID
- **submissionId** (string) - Required - ID of workflow submission to retrieve revisions for
- **revisionId** (string) - Required - ID of the particular submission revision to retrieve

### Response
#### Success Response (200)
- **id** (string) - Revision ID
- **created** (string) - Creation timestamp
- **submission** (object) - Submission details including metadata and data formats
```

--------------------------------

### GET /api/1.0/promote/hosts

Source: https://developers.unqork.io/

Returns a list of environments authorized for promotion. Requires Application Promote, Style Promote, or Data Collections Promote permissions.

```APIDOC
## GET /api/1.0/promote/hosts

### Description
Returns list of environments authorized for promotion.

### Method
GET

### Endpoint
https://{host}/api/1.0/promote/hosts

### Authorization Required:
Application Promote or Style Promote or Data Collections Promote

##### Authorizations:
OAuth2

### Responses
#### Success Response (200)
- **Hosts Loaded** (string) - Confirmation message.

#### Response Example
```json
[
  {
    "clientName": "string",
    "clientLevel": "string",
    "isProduction": true
  }
]
```

#### Error Response (default)
- **Error** (object) - Description of the error object
```

--------------------------------

### GET /modules/{moduleId}/api

Source: https://developers.unqork.io/

Retrieves information or executes a module via GET request. Supports various response codes for validation and execution status.

```APIDOC
## GET /modules/{moduleId}/api

### Description
Retrieves information or executes a module via GET request. The response can indicate submission validation or execution errors.

### Method
GET

### Endpoint
https://{host}/api/1.0/modules/{moduleId}/api

### Parameters
#### Path Parameters
- **moduleId** (string) - Required - The module specified by moduleId must meet the following requirements:
  * It MUST be marked as Server-side Execute Only
  * It MAY be marked as anonymous
  * It MAY reference a submission data getter for object key _request

### Responses
#### Success Response (200)
Submission validated

#### Error Response (412)
Validation and/or execution error

#### Custom Responses (2XX, 4XX, 5XX)
Custom HTTP status code if set by server side execution for API modules

#### Default Response
Error

### Response Example (200)
{
  "id": "string",
  "userId": "string",
  "moduleId": "string",
  "created": "2019-08-24T14:15:22Z",
  "modified": "2019-08-24T14:15:22Z",
  "deleted": "2019-08-24T14:15:22Z",
  "data": {
    "rawData": { },
    "resolved": { }
  },
  "metadata": { },
  "validationErrors": [
    {
      "id": "string",
      "path": "string",
      "label": "string",
      "parent": "string",
      "message": "string"
    }
  ],
  "invalidNavigationPanels": [
    {
      "key": "string",
      "label": "string"
    }
  ]
}
```

--------------------------------

### POST /applications

Source: https://developers.unqork.io/

Creates a new application in the platform.

```APIDOC
## POST /applications

### Description
Create a new application.

### Method
POST

### Endpoint
https://{host}/api/1.0/applications

### Parameters
#### Request Body
- **id** (string) - Required - Id of the new application
- **name** (string) - Required - Name of the new application
- **settings** (object) - Optional - Application settings
- **revisions** (boolean) - Optional - Enable revisions
- **title** (string) - Required - Title of the new application
- **type** (string) - Required - Type of the new application ('form' or 'workflow')
- **workspaceId** (string) - Optional - Workspace Id that should contain the new application

### Request Example
{
  "id": "string",
  "name": "string",
  "settings": {},
  "revisions": true,
  "title": "string",
  "type": "string",
  "workspaceId": "string"
}

### Response
#### Success Response (201)
- **Object** (object) - JSON describing the new application.
```

--------------------------------

### User Creation Response Sample

Source: https://developers.unqork.io/

This JSON object represents a successful response after creating a user. It includes user details along with creation and modification timestamps, and last login information.

```json
{
  "userId": "string",
  "name": "string",
  "email": "string",
  "phone": "string",
  "role": "Authenticated",
  "expressRoles": [
    "Authenticated"
],
  "groups": [ ],
  "applicationRoles": { },
  "created": "2019-08-24T14:15:22Z",
  "modified": "2019-08-24T14:15:22Z",
  "isServiceUser": true,
  "lastLogin": "2019-08-24T14:15:22Z",
  "...customAttributes": "string"

}
```

--------------------------------

### GET /api/1.0/submissions/{moduleId} - Get Module Submissions

Source: https://developers.unqork.io/

Retrieves module submission objects for a given module. This is a paged endpoint. Submission data can be transformed and returned in JSON, XML, or PDF format.

```APIDOC
## GET /api/1.0/submissions/{moduleId}

### Description
Returns module submission objects for a given module. This is a paged endpoint. Module submission data is transformed and returned in a specific format, based on the specified transform. JSON submission data is returned as an object, XML data is returned as a string, and PDF data is returned as a Cloud Storage Delivery URL to the rendered PDF.

### Method
GET

### Endpoint
https://{host}/api/1.0/submissions/{moduleId}

### Parameters
#### Path Parameters
- **moduleId** (string) - Required - Unique module ID.

### Authorization
See Submission Access (Submission Access)

### Authorizations
OAuth2
```

--------------------------------

### GET /api/1.0/globalvars

Source: https://developers.unqork.io/

Retrieves a list of all global variables.

```APIDOC
## GET /api/1.0/globalvars

### Description
Retrieves a list of all global variables.

### Method
GET

### Endpoint
https://{host}/api/1.0/globalvars

### Response
#### Success Response (200)
- **id** (string) - Unique identifier
- **key** (string) - Variable key
- **value** (string) - Variable value
- **description** (string) - Variable description
- **serverSideOnly** (boolean) - Server-side availability flag
- **created** (string) - Creation timestamp
- **createdBy** (string) - Creator identifier
- **modified** (string) - Modification timestamp
- **modifiedBy** (string) - Modifier identifier
- **deleted** (string) - Deletion timestamp

#### Response Example
[
  {
    "id": "string",
    "key": "string",
    "value": "string",
    "description": "string",
    "serverSideOnly": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modified": "2019-08-24T14:15:22Z",
    "modifiedBy": "string",
    "deleted": "2019-08-24T14:15:22Z"
  }
]
```

--------------------------------

### POST /api/1.0/promote/module

Source: https://developers.unqork.io/

Promotes a specific module to a target environment. Requires Application Promote permission.

```APIDOC
## POST /api/1.0/promote/module

### Description
Promote a specific module.

### Method
POST

### Endpoint
https://{host}/api/1.0/promote/module

### Authorization Required:
Application Promote

##### Authorizations:
OAuth2

#### Request Body
- **clientName** (string) - Required - Target environment name.
- **clientLevel** (string) - Required - Level of the environment (qa, uat, production, etc.).
- **moduleId** (string) - Required - ID of module to Promote.

### Request Example
```json
{
  "clientName": "string",
  "clientLevel": "string",
  "moduleId": "string"
}
```

### Responses
#### Success Response (204)
- **Job Executed** (string) - Confirmation message.

#### Error Response (default)
- **Error** (object) - Description of the error object

#### Response Example
```json
{
  "code": 400,
  "message": "string"
}
```
```

--------------------------------

### GET /applications/unique

Source: https://developers.unqork.io/

Checks if a provided application name is unique.

```APIDOC
## GET /applications/unique

### Description
Determines if an application's name is unique.

### Method
GET

### Endpoint
https://{host}/api/1.0/applications/unique

### Parameters
#### Query Parameters
- **name** (string) - Required - Name to check if it is a unique application name

### Response
#### Success Response (200)
- **Boolean** (boolean) - Describes if the supplied name is a unique application name

#### Response Example
true
```

--------------------------------

### Get Groups

Source: https://developers.unqork.io/

Returns group objects. This is a paged endpoint.

```APIDOC
## GET /api/1.0/groups

### Description
Returns group objects. This is a paged endpoint.

### Authorization Required
- Designer Administrator

### Method
GET

### Endpoint
https://{host}/api/1.0/groups

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Maximum number of results to return (default 1000, maximum 1000).

### Response
#### Success Response (200)
Groups
- **name** (string) - Description
- **description** (string) - Description
- **type** (string) - Description

#### Response Example
```json
[
  {
    "name": "string",
    "description": "string",
    "type": "role_descendents"
  }
]
```
```

--------------------------------

### Get Modules API

Source: https://developers.unqork.io/

Returns module objects. This is a paged endpoint.

```APIDOC
## GET /api/1.0/modules

### Description
Returns module objects. This is a paged endpoint.

### Method
GET

### Endpoint
/api/1.0/modules

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Maximum number of results to return (default 50, maximum 50).

### Response
#### Success Response (200)
Modules.

#### Response Example
```json
[
  {
    "id": "string",
    "name": "string",
    "title": "string",
    "created": "2019-08-24T14:15:22Z",
    "modified": "2019-08-24T14:15:22Z"
  }
]
```
```

--------------------------------

### GET /modules/{moduleId}/transforms/{transformName}

Source: https://developers.unqork.io/

Retrieves a specific transform by its name.

```APIDOC
## GET /modules/{moduleId}/transforms/{transformName}

### Description
Returns a single transform object based on the module ID and transform name.

### Method
GET

### Endpoint
https://{host}/api/1.0/modules/{moduleId}/transforms/{transformName}

### Parameters
#### Path Parameters
- **moduleId** (string) - Required - Unique module ID
- **transformName** (string) - Required - Name of the transform

### Response
#### Success Response (200)
- **Object** - The requested transform

#### Response Example
{
  "name": "string",
  "moduleId": "string",
  "type": "njk-xml",
  "io": "in",
  "template": "string"
}
```

--------------------------------

### POST /api/1.0/promote/applicationByItems

Source: https://developers.unqork.io/

Promotes an application by specifying its components like modules, reference data collections, and archives.

```APIDOC
## POST /api/1.0/promote/applicationByItems

### Description
Promotes an application by specifying its components like modules, reference data collections, and archives.

### Method
POST

### Endpoint
https://{host}/api/1.0/promote/applicationByItems

### Parameters
#### Request Body
- **clientName** (string) - Required - Target environment name
- **clientLevel** (string) - Required - Level of the environment (qa, uat, production, etc.)
- **applicationId** (string) - Required - applicationId of the application to promote
- **modules** (Array of strings) - Optional - Array of Modules to Promote
- **referenceDataCollections** (Array of strings) - Optional - Array of Reference Data Collections to Promote
- **moduleArchives** (Array of objects) - Optional - Array of Module Archives to Promote. Must include the moduleId
- **workflowArchives** (Array of strings) - Optional - Array of Workflow Archives to Promote
- **workflows** (Array of strings) - Optional - Array of Workflows to Promote
- **dataSchemaIds** (Array of strings) - Optional - Array of Data Schemas to Promote
- **dataModels** (Array of strings) - Optional - Array of Data Models to Promote
- **schemas** (Array of strings) - Optional - Array of Data Model Schemas to Promote
- **searchConfigs** (Array of strings) - Optional - Array of Queries to Promote

### Request Example
{
  "clientName": "string",
  "clientLevel": "string",
  "applicationId": "string",
  "modules": [
    "moduleId1",
    "moduleId2"
  ],
  "referenceDataCollections": [
    "collectionName1",
    "collectionName2"
  ],
  "moduleArchives": [
    {
      "moduleId": "moduleId",
      "archiveId": "archiveId of the Module"
    }
  ],
  "workflowArchives": [
    "workflowArchiveId1",
    "workflowArchiveId2"
  ],
  "workflows": [
    "workflowId1",
    "workflowId2"
  ],
  "dataSchemaIds": [
    "dataSchemaId1",
    "dataSchemaId2"
  ],
  "dataModels": [
    "dataModelId1",
    "dataModelId2"
  ],
  "schemas": [
    "schemaId1",
    "schemaId2"
  ],
  "searchConfigs": [
    "queryId1",
    "queryId2"
  ]
}

### Response
#### Success Response (200)
Job Execution Initiated.

#### Response Example
(No specific example provided for success response, but it indicates job initiation.)

#### Error Response (default)
- **code** (integer) - Description
- **message** (string) - Description

#### Response Example
{
  "code": 400,
  "message": "string"
}
```

--------------------------------

### Get Transform Response

Source: https://developers.unqork.io/

The JSON structure returned when retrieving a specific transform.

```json
{
  * "name": "string",
  * "moduleId": "string",
  * "type": "njk-xml",
  * "io": "in",
  * "template": "string"

}
```

--------------------------------

### GET /applications/{applicationId}/workspace

Source: https://developers.unqork.io/

Retrieves the workspace associated with a specific application.

```APIDOC
## GET /applications/{applicationId}/workspace

### Description
Gets the workspace that contains the application.

### Method
GET

### Endpoint
https://{host}/api/1.0/applications/{applicationId}/workspace

### Parameters
#### Path Parameters
- **applicationId** (string) - Required - Unique identifier for an application

### Response
#### Success Response (200)
- **Object** (object) - JSON object describing the found workspace.

#### Response Example
{
  "private": true,
  "parent": "string",
  "_id": "string",
  "name": "string",
  "owner": "string",
  "created": "string",
  "modified": "string"
}
```

--------------------------------

### Module Submission Response (201)

Source: https://developers.unqork.io/

This is a sample successful response for creating a module submission. It includes details about the created submission.

```json
{
  "id": "string",
  "userId": "string",
  "moduleId": "string",
  "created": "2019-08-24T14:15:22Z",
  "modified": "2019-08-24T14:15:22Z",
  "deleted": "2019-08-24T14:15:22Z",
  "data": {
    "rawData": { }
},
  "metadata": { },
  "validationErrors": [
    {
      "id": "string",
      "path": "string",
      "label": "string",
      "parent": "string",
      "message": "string"
}
]

}
```

--------------------------------

### GET /api/1.0/credentials

Source: https://developers.unqork.io/

Retrieves a list of credentials based on optional filters, sorting, and pagination.

```APIDOC
## GET /api/1.0/credentials

### Description
Get credentials. Requires Designer Administrator authorization.

### Method
GET

### Endpoint
https://{host}/api/1.0/credentials

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Default: 100000. Limit the number of applications returned (Cannot exceed 1000).
- **sort** (string) - Optional - Default: "created". Field to sort found applications by.
- **offset** (integer) - Optional - Default: 0. Offset for paginated results.
- **sortOrder** (integer) - Optional - Default: -1. Sort order (1 = ascending, -1 = descending).
- **filter** (string) - Optional - Filter conditions for searching users.

### Response
#### Success Response (200)
- **Array** (array) - Array containing JSON objects of each found credential

#### Response Example
[
  {
    "clientId": "string",
    "name": "string",
    "role": "string",
    "roles": ["string"],
    "groups": ["string"],
    "applicationRoles": {},
    "created": "string",
    "modified": "string",
    "status": "string",
    "credentialType": "string",
    "expireDate": "string"
  }
]
```

--------------------------------

### Applications API

Source: https://developers.unqork.io/

Endpoints for managing applications within the Unqork environment.

```APIDOC
## GET /api/1.0/applications/{applicationId}/resource/{resourceId}

### Description
Determines if a resource is part of an application.

### Method
GET

### Endpoint
/api/1.0/applications/{applicationId}/resource/{resourceId}

### Parameters
#### Path Parameters
- **applicationId** (string) - Required - The ID of the application.
- **resourceId** (string) - Required - The ID of the resource.

### Response
#### Success Response (200)
- **isResourceInApplication** (boolean) - True if the resource is in the application, false otherwise.

#### Response Example
{
  "isResourceInApplication": true
}
```

```APIDOC
## GET /api/1.0/applications/{applicationId}/components/export

### Description
Retrieves the exportable components of an application.

### Method
GET

### Endpoint
/api/1.0/applications/{applicationId}/components/export

### Parameters
#### Path Parameters
- **applicationId** (string) - Required - The ID of the application.

### Response
#### Success Response (200)
- **components** (array) - A list of exportable component objects.

#### Response Example
{
  "components": [
    {
      "id": "comp1",
      "name": "Form"
    }
  ]
}
```

```APIDOC
## GET /api/1.0/applications/{applicationId}/submission/data-model

### Description
Retrieves the submission data model for an application.

### Method
GET

### Endpoint
/api/1.0/applications/{applicationId}/submission/data-model

### Parameters
#### Path Parameters
- **applicationId** (string) - Required - The ID of the application.

### Response
#### Success Response (200)
- **dataModel** (object) - The submission data model.

#### Response Example
{
  "dataModel": {
    "fields": [
      {
        "name": "fieldName",
        "type": "string"
      }
    ]
  }
}
```

```APIDOC
## GET /api/1.0/applications/{applicationId}/dependencies/data-models

### Description
Retrieves the data model dependencies of an application.

### Method
GET

### Endpoint
/api/1.0/applications/{applicationId}/dependencies/data-models

### Parameters
#### Path Parameters
- **applicationId** (string) - Required - The ID of the application.

### Response
#### Success Response (200)
- **dependencies** (array) - A list of data model dependency objects.

#### Response Example
[
  {
    "name": "DataModelA"
  }
]
```

```APIDOC
## GET /api/1.0/applications/{applicationId}/modules

### Description
Retrieves the modules associated with an application.

### Method
GET

### Endpoint
/api/1.0/applications/{applicationId}/modules

### Parameters
#### Path Parameters
- **applicationId** (string) - Required - The ID of the application.

### Response
#### Success Response (200)
- **modules** (array) - A list of module objects.

#### Response Example
[
  {
    "id": "module1",
    "name": "User Form"
  }
]
```

```APIDOC
## GET /api/1.0/applications/unique-name/{applicationName}

### Description
Determines if an application name is unique.

### Method
GET

### Endpoint
/api/1.0/applications/unique-name/{applicationName}

### Parameters
#### Path Parameters
- **applicationName** (string) - Required - The name of the application to check.

### Response
#### Success Response (200)
- **isUnique** (boolean) - True if the name is unique, false otherwise.

#### Response Example
{
  "isUnique": true
}
```

```APIDOC
## GET /api/1.0/applications/{applicationId}/workspace

### Description
Retrieves the workspace details for an application.

### Method
GET

### Endpoint
/api/1.0/applications/{applicationId}/workspace

### Parameters
#### Path Parameters
- **applicationId** (string) - Required - The ID of the application.

### Response
#### Success Response (200)
- **workspace** (object) - The workspace details.

#### Response Example
{
  "workspace": {
    "url": "https://workspace.unqork.io"
  }
}
```

```APIDOC
## POST /api/1.0/applications/{applicationId}/restore

### Description
Restores a deleted application.

### Method
POST

### Endpoint
/api/1.0/applications/{applicationId}/restore

### Parameters
#### Path Parameters
- **applicationId** (string) - Required - The ID of the application to restore.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Application restored successfully."
}
```

```APIDOC
## PUT /api/1.0/applications/{applicationId}/connect

### Description
Connects an application.

### Method
PUT

### Endpoint
/api/1.0/applications/{applicationId}/connect

### Parameters
#### Path Parameters
- **applicationId** (string) - Required - The ID of the application to connect.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Application connected successfully."
}
```

```APIDOC
## POST /api/1.0/applications

### Description
Creates a new application.

### Method
POST

### Endpoint
/api/1.0/applications

### Request Body
- **name** (string) - Required - The name of the new application.
- **description** (string) - Optional - A description for the application.

### Request Example
{
  "name": "New App",
  "description": "My first Unqork application."
}

### Response
#### Success Response (200)
- **id** (string) - The ID of the newly created application.

#### Response Example
{
  "id": "app999"
}
```

```APIDOC
## GET /api/1.0/applications

### Description
Retrieves a list of applications.

### Method
GET

### Endpoint
/api/1.0/applications

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve.
- **size** (integer) - Optional - The number of items per page.

### Response
#### Success Response (200)
- **applications** (array) - A list of application objects.
- **total** (integer) - The total number of applications.

#### Response Example
{
  "applications": [
    {
      "id": "app555",
      "name": "Existing App"
    }
  ],
  "total": 1
}
```

```APIDOC
## GET /api/1.0/applications/{applicationId}

### Description
Retrieves a specific application by its ID.

### Method
GET

### Endpoint
/api/1.0/applications/{applicationId}

### Parameters
#### Path Parameters
- **applicationId** (string) - Required - The ID of the application to retrieve.

### Response
#### Success Response (200)
- **id** (string) - The application's ID.
- **name** (string) - The application's name.

#### Response Example
{
  "id": "app555",
  "name": "Existing App"
}
```

```APIDOC
## PUT /api/1.0/applications/{applicationId}

### Description
Updates an existing application.

### Method
PUT

### Endpoint
/api/1.0/applications/{applicationId}

### Parameters
#### Path Parameters
- **applicationId** (string) - Required - The ID of the application to update.

### Request Body
- **name** (string) - Optional - The new name for the application.
- **description** (string) - Optional - The new description for the application.

### Request Example
{
  "name": "Updated App Name"
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Application updated successfully."
}
```

```APIDOC
## DELETE /api/1.0/applications/{applicationId}

### Description
Deletes an application by its ID.

### Method
DELETE

### Endpoint
/api/1.0/applications/{applicationId}

### Parameters
#### Path Parameters
- **applicationId** (string) - Required - The ID of the application to delete.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Application deleted successfully."
}
```

--------------------------------

### GET /modules/{moduleId}/transforms

Source: https://developers.unqork.io/

Retrieves a list of transform objects for a specific module.

```APIDOC
## GET /modules/{moduleId}/transforms

### Description
Returns a paged list of transform objects associated with the specified module.

### Method
GET

### Endpoint
https://{host}/api/1.0/modules/{moduleId}/transforms

### Parameters
#### Path Parameters
- **moduleId** (string) - Required - Unique module ID

#### Query Parameters
- **limit** (integer) - Optional - Maximum number of results to return (default 50, maximum 1000)

### Response
#### Success Response (200)
- **Array of objects** - List of transforms

#### Response Example
[
  {
    "name": "string",
    "moduleId": "string",
    "type": "njk-xml",
    "io": "in",
    "template": "string"
  }
]
```

--------------------------------

### POST /api/1.0/promote/roles

Source: https://developers.unqork.io/

Promotes all roles to a target environment.

```APIDOC
## POST /api/1.0/promote/roles

### Description
Promotes all roles to a target environment.

### Method
POST

### Endpoint
https://{host}/api/1.0/promote/roles

### Parameters
#### Request Body
- **clientName** (string) - Required - Target environment name
- **clientLevel** (string) - Required - Level of the environment (qa, uat, production, etc.)

### Request Example
{
  "clientName": "string",
  "clientLevel": "string"
}

### Response
#### Success Response (204)
Job Executed.

#### Error Response (default)
- **code** (integer) - Description
- **message** (string) - Description

#### Response Example
{
  "code": 400,
  "message": "string"
}
```

--------------------------------

### POST /api/1.0/credentials

Source: https://developers.unqork.io/

Creates a new credential in the system.

```APIDOC
## POST /api/1.0/credentials

### Description
Create a credential. Requires Designer Administrator authorization.

### Method
POST

### Endpoint
https://{host}/api/1.0/credentials

### Parameters
#### Request Body
- **clientId** (string) - Required - Client ID of the credential.
- **clientSecret** (string) - Required - Client secret of the credential.
- **description** (string) - Optional - Description of the credential.
- **designerRoles** (string) - Optional - Creator roles of the credential.
- **expressRoles** (string) - Optional - Express roles of the credential.
- **name** (string) - Required - Name of the credential.

### Request Example
{
  "clientId": "string",
  "clientSecret": "string",
  "description": "string",
  "designerRoles": "string",
  "expressRoles": "string",
  "name": "string"
}

### Response
#### Success Response (200)
- **Object** (object) - JSON describing the created credential

#### Response Example
{
  "clientId": "string",
  "name": "string",
  "role": "string",
  "roles": ["string"],
  "groups": ["string"],
  "applicationRoles": {},
  "created": "string",
  "modified": "string",
  "status": "string",
  "credentialType": "string",
  "expireDate": "string"
}
```

--------------------------------

### Get Transforms Response Schema

Source: https://developers.unqork.io/

The JSON structure returned when fetching a list of transforms.

```json
[
  * {
    * "name": "string",
    * "moduleId": "string",
    * "type": "njk-xml",
    * "io": "in",
    * "template": "string"
}

]
```

--------------------------------

### POST /api/1.0/referstring - Generate Refer String

Source: https://developers.unqork.io/

Generates encrypted refer strings for user authentication into an Unqork environment. Environment variables for encryption key and cipher are required.

```APIDOC
## POST /api/1.0/referstring

### Description
Generates encrypted refer strings that can be used to authenticate users into an Unqork environment. Environment Variables - The following Environment Variables are required: key for encryption, cipher for encryption method (default and recommended is aes-256-gcm).

### Method
POST

### Endpoint
https://{host}/api/1.0/referstring

### Parameters
#### Request Body
- **userId** (string) - Required - Unique ID of the user.
- **expireOffset** (integer) - Optional - Provides an amount of time until expiry. Maximum offset 30 days or equivalent. Default offset 1.
- **expireMeasure** (string) - Optional - Units for the expireOffset parameter (e.g. hours, days). Maximum offset 8 days or equivalent. Default measure hours.
- **oneTimeUse** (boolean) - Optional - Whether to limit the refer string to one use. Recommended to set to `true` for best security.
- **additionalParams** (object) - Optional - An object with anything else to be added to referstring.

### Request Example
```json
{
  "userId": "user123",
  "expireOffset": 1,
  "expireMeasure": "days",
  "oneTimeUse": true,
  "additionalParams": {
    "role": "customRole"
  }
}
```

### Response
#### Success Response (200)
- **referString** (string) - The generated encrypted refer string.

#### Response Example
```json
{
  "referString": "<encrypted refer string>"
}
```

#### Error Response (default)
- **code** (integer) - Error code.
- **message** (string) - Error message.

#### Error Response Example
```json
{
  "code": 400,
  "message": "string"
}
```
```

--------------------------------

### POST /applications/{applicationId}/restore

Source: https://developers.unqork.io/

Restores an application to a specified workspace.

```APIDOC
## POST /applications/{applicationId}/restore

### Description
Restores an application.

### Method
POST

### Endpoint
https://{host}/api/1.0/applications/{applicationId}/restore

### Parameters
#### Path Parameters
- **applicationId** (string) - Required - Unique identifier for an application

#### Request Body
- **workspaceId** (string) - Optional - Unique identifier for the workspace to restore the application to

### Request Example
{
  "workspaceId": "string"
}

### Response
#### Success Response (200)
- **Object** (object) - JSON object describing the restored application.

#### Response Example
{
  "created": "string",
  "createdBy": "string",
  "dataSchemas": [],
  "description": "string",
  "id": "string",
  "modified": "string",
  "modifiedBy": "string",
  "name": "string",
  "promotions": {},
  "settings": {},
  "title": "string",
  "type": "string",
  "workspaceId": "string"
}
```