# Models

## The AcknowledgeInstanceErrorsQueryModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"AcknowledgeInstanceErrorsQueryModel":{"required":["instanceIds","reason"],"type":"object","properties":{"reason":{"type":"string"},"instanceIds":{"type":"array","items":{"type":"integer","format":"int64"}}},"additionalProperties":false}}}}
```

## The AgentEventViewModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"AgentEventViewModel":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"eventId":{"type":"integer","format":"int64"},"level":{"type":"string"},"utcTimestamp":{"type":"string","format":"date-time"},"category":{"type":"integer","format":"int32"},"source":{"type":"string"},"message":{"type":"string"}},"additionalProperties":false}}}}
```

## The AgentEventViewModelPagedResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"AgentEventViewModelPagedResponse":{"required":["Data","Paging"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AgentEventViewModel"},"description":"Response data"},"paging":{"$ref":"#/components/schemas/PagingModel"}},"additionalProperties":false},"AgentEventViewModel":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"eventId":{"type":"integer","format":"int64"},"level":{"type":"string"},"utcTimestamp":{"type":"string","format":"date-time"},"category":{"type":"integer","format":"int32"},"source":{"type":"string"},"message":{"type":"string"}},"additionalProperties":false},"PagingModel":{"required":["CurrentPage","FirstPage","LastPage","PageSize","TotalCount"],"type":"object","properties":{"currentPage":{"type":"integer","description":"Current page","format":"int32"},"pageSize":{"type":"integer","description":"Number of entries per page","format":"int32"},"totalCount":{"type":"integer","description":"Total number of entries","format":"int32"},"firstPage":{"type":"string","description":"Url of the first page","format":"uri","nullable":true},"lastPage":{"type":"string","description":"Url of the last page","format":"uri","nullable":true},"nextPage":{"type":"string","description":"Url of the next page","format":"uri","nullable":true},"previousPage":{"type":"string","description":"Url of the previous page","format":"uri","nullable":true}},"additionalProperties":false}}}}
```

## The ApiAccessRuleType object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiAccessRuleType":{"enum":["Allow","Deny"],"type":"string"}}}}
```

## The ApiKeyViewModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiKeyViewModel":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string","nullable":true},"environment":{"type":"string","nullable":true},"value":{"type":"string","format":"uuid"}},"additionalProperties":false}}}}
```

## The ApiPassthroughCreateModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPassthroughCreateModel":{"type":"object","properties":{"corsEnabled":{"type":"boolean","description":"Is CORS enabled"},"targetUrl":{"$ref":"#/components/schemas/ApiPassthroughTarget"},"headers":{"type":"array","items":{"$ref":"#/components/schemas/ApiPassthroughHeader"},"description":"Header definitions","nullable":true},"allowedOrigins":{"type":"array","items":{"type":"string"},"description":"Allowed origins. Used when CORS is enabled.","nullable":true},"path":{"type":"string","description":"Source API path for this passthrough configuration. Not used when IsDefault is set to true.","nullable":true},"method":{"type":"string","description":"HTTP method. Not used when IsDefault is set to true.","nullable":true},"isDefault":{"type":"boolean","description":"Is this configuration used for all paths and HTTP methods"}},"additionalProperties":false},"ApiPassthroughTarget":{"type":"object","properties":{"server":{"type":"string","description":"Server part of the target URL"},"basePath":{"type":"string","description":"Base path of the target URL"},"operationPath":{"type":"string","description":"Operation path of the target URL","nullable":true},"query":{"type":"string","description":"Query parameters of the target URL","nullable":true}},"additionalProperties":false},"ApiPassthroughHeader":{"type":"object","properties":{"action":{"type":"string","description":"Header action (Add, Overwrite, Remove)"},"name":{"type":"string","description":"Header name"},"value":{"type":"string","description":"Header value"}},"additionalProperties":false}}}}
```

## The ApiPassthroughEditModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPassthroughEditModel":{"type":"object","properties":{"corsEnabled":{"type":"boolean","description":"Is CORS enabled"},"targetUrl":{"$ref":"#/components/schemas/ApiPassthroughTarget"},"headers":{"type":"array","items":{"$ref":"#/components/schemas/ApiPassthroughHeader"},"description":"Header definitions","nullable":true},"allowedOrigins":{"type":"array","items":{"type":"string"},"description":"Allowed origins. Used when CORS is enabled.","nullable":true}},"additionalProperties":false},"ApiPassthroughTarget":{"type":"object","properties":{"server":{"type":"string","description":"Server part of the target URL"},"basePath":{"type":"string","description":"Base path of the target URL"},"operationPath":{"type":"string","description":"Operation path of the target URL","nullable":true},"query":{"type":"string","description":"Query parameters of the target URL","nullable":true}},"additionalProperties":false},"ApiPassthroughHeader":{"type":"object","properties":{"action":{"type":"string","description":"Header action (Add, Overwrite, Remove)"},"name":{"type":"string","description":"Header name"},"value":{"type":"string","description":"Header value"}},"additionalProperties":false}}}}
```

## The ApiPassthroughHeader object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPassthroughHeader":{"type":"object","properties":{"action":{"type":"string","description":"Header action (Add, Overwrite, Remove)"},"name":{"type":"string","description":"Header name"},"value":{"type":"string","description":"Header value"}},"additionalProperties":false}}}}
```

## The ApiPassthroughTarget object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPassthroughTarget":{"type":"object","properties":{"server":{"type":"string","description":"Server part of the target URL"},"basePath":{"type":"string","description":"Base path of the target URL"},"operationPath":{"type":"string","description":"Operation path of the target URL","nullable":true},"query":{"type":"string","description":"Query parameters of the target URL","nullable":true}},"additionalProperties":false}}}}
```

## The ApiPassthroughViewModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPassthroughViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the passthrough configuration","format":"int64"},"apiVersionId":{"type":"integer","description":"Unique identifier of the API version","format":"int64"},"modifier":{"type":"string","description":"User who last modified the configuration"},"modified":{"type":"string","description":"Time when configuration was last modified","format":"date-time"},"path":{"type":"string","description":"Source API path for this passthrough configuration. Not used when IsDefault is set to true.","nullable":true},"method":{"type":"string","description":"HTTP method. Not used when IsDefault is set to true.","nullable":true},"isDefault":{"type":"boolean","description":"Is this configuration used for all paths and HTTP methods"},"corsEnabled":{"type":"boolean","description":"Is CORS enabled"},"targetUrl":{"$ref":"#/components/schemas/ApiPassthroughTarget"},"headers":{"type":"array","items":{"$ref":"#/components/schemas/ApiPassthroughHeader"},"description":"Header definitions","nullable":true},"allowedOrigins":{"type":"array","items":{"type":"string"},"description":"Allowed origins. Used when CORS is enabled.","nullable":true}},"additionalProperties":false},"ApiPassthroughTarget":{"type":"object","properties":{"server":{"type":"string","description":"Server part of the target URL"},"basePath":{"type":"string","description":"Base path of the target URL"},"operationPath":{"type":"string","description":"Operation path of the target URL","nullable":true},"query":{"type":"string","description":"Query parameters of the target URL","nullable":true}},"additionalProperties":false},"ApiPassthroughHeader":{"type":"object","properties":{"action":{"type":"string","description":"Header action (Add, Overwrite, Remove)"},"name":{"type":"string","description":"Header name"},"value":{"type":"string","description":"Header value"}},"additionalProperties":false}}}}
```

## The ApiPassthroughViewModelIListResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPassthroughViewModelIListResponse":{"required":["Data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiPassthroughViewModel"},"description":"Response data","nullable":true}},"additionalProperties":false},"ApiPassthroughViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the passthrough configuration","format":"int64"},"apiVersionId":{"type":"integer","description":"Unique identifier of the API version","format":"int64"},"modifier":{"type":"string","description":"User who last modified the configuration"},"modified":{"type":"string","description":"Time when configuration was last modified","format":"date-time"},"path":{"type":"string","description":"Source API path for this passthrough configuration. Not used when IsDefault is set to true.","nullable":true},"method":{"type":"string","description":"HTTP method. Not used when IsDefault is set to true.","nullable":true},"isDefault":{"type":"boolean","description":"Is this configuration used for all paths and HTTP methods"},"corsEnabled":{"type":"boolean","description":"Is CORS enabled"},"targetUrl":{"$ref":"#/components/schemas/ApiPassthroughTarget"},"headers":{"type":"array","items":{"$ref":"#/components/schemas/ApiPassthroughHeader"},"description":"Header definitions","nullable":true},"allowedOrigins":{"type":"array","items":{"type":"string"},"description":"Allowed origins. Used when CORS is enabled.","nullable":true}},"additionalProperties":false},"ApiPassthroughTarget":{"type":"object","properties":{"server":{"type":"string","description":"Server part of the target URL"},"basePath":{"type":"string","description":"Base path of the target URL"},"operationPath":{"type":"string","description":"Operation path of the target URL","nullable":true},"query":{"type":"string","description":"Query parameters of the target URL","nullable":true}},"additionalProperties":false},"ApiPassthroughHeader":{"type":"object","properties":{"action":{"type":"string","description":"Header action (Add, Overwrite, Remove)"},"name":{"type":"string","description":"Header name"},"value":{"type":"string","description":"Header value"}},"additionalProperties":false}}}}
```

## The ApiPassthroughViewModelResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPassthroughViewModelResponse":{"required":["Data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/ApiPassthroughViewModel"}},"additionalProperties":false},"ApiPassthroughViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the passthrough configuration","format":"int64"},"apiVersionId":{"type":"integer","description":"Unique identifier of the API version","format":"int64"},"modifier":{"type":"string","description":"User who last modified the configuration"},"modified":{"type":"string","description":"Time when configuration was last modified","format":"date-time"},"path":{"type":"string","description":"Source API path for this passthrough configuration. Not used when IsDefault is set to true.","nullable":true},"method":{"type":"string","description":"HTTP method. Not used when IsDefault is set to true.","nullable":true},"isDefault":{"type":"boolean","description":"Is this configuration used for all paths and HTTP methods"},"corsEnabled":{"type":"boolean","description":"Is CORS enabled"},"targetUrl":{"$ref":"#/components/schemas/ApiPassthroughTarget"},"headers":{"type":"array","items":{"$ref":"#/components/schemas/ApiPassthroughHeader"},"description":"Header definitions","nullable":true},"allowedOrigins":{"type":"array","items":{"type":"string"},"description":"Allowed origins. Used when CORS is enabled.","nullable":true}},"additionalProperties":false},"ApiPassthroughTarget":{"type":"object","properties":{"server":{"type":"string","description":"Server part of the target URL"},"basePath":{"type":"string","description":"Base path of the target URL"},"operationPath":{"type":"string","description":"Operation path of the target URL","nullable":true},"query":{"type":"string","description":"Query parameters of the target URL","nullable":true}},"additionalProperties":false},"ApiPassthroughHeader":{"type":"object","properties":{"action":{"type":"string","description":"Header action (Add, Overwrite, Remove)"},"name":{"type":"string","description":"Header name"},"value":{"type":"string","description":"Header value"}},"additionalProperties":false}}}}
```

## The ApiPolicyApiKeyGroupAssignmentSaveModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPolicyApiKeyGroupAssignmentSaveModel":{"required":["apiKey"],"type":"object","properties":{"apiKey":{"$ref":"#/components/schemas/ApiPolicyApiKeySaveModel"}},"additionalProperties":false},"ApiPolicyApiKeySaveModel":{"type":"object","properties":{"id":{"type":"integer","description":"The API key identifier","format":"int64"}},"additionalProperties":false}}}}
```

## The ApiPolicyApiKeyGroupAssignmentViewModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPolicyApiKeyGroupAssignmentViewModel":{"required":["apiKey"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the assignment","format":"int64"},"apiKey":{"$ref":"#/components/schemas/ApiKeyViewModel"}},"additionalProperties":false},"ApiKeyViewModel":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string","nullable":true},"environment":{"type":"string","nullable":true},"value":{"type":"string","format":"uuid"}},"additionalProperties":false}}}}
```

## The ApiPolicyApiKeyGroupSaveModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPolicyApiKeyGroupSaveModel":{"required":["apiPolicyApiKeyGroupAssignments","name"],"type":"object","properties":{"requestLimit":{"type":"integer","description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32","nullable":true},"requestLimitWindowInMinutes":{"type":"integer","description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32","nullable":true},"name":{"type":"string","description":"The name of the API key group"},"apiPolicyApiKeyGroupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignmentSaveModel"},"description":"The API key group assignments"}},"additionalProperties":false},"ApiPolicyApiKeyGroupAssignmentSaveModel":{"required":["apiKey"],"type":"object","properties":{"apiKey":{"$ref":"#/components/schemas/ApiPolicyApiKeySaveModel"}},"additionalProperties":false},"ApiPolicyApiKeySaveModel":{"type":"object","properties":{"id":{"type":"integer","description":"The API key identifier","format":"int64"}},"additionalProperties":false}}}}
```

## The ApiPolicyApiKeyGroupViewModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPolicyApiKeyGroupViewModel":{"required":["name"],"type":"object","properties":{"requestLimit":{"type":"integer","description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32","nullable":true},"requestLimitWindowInMinutes":{"type":"integer","description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32","nullable":true},"name":{"type":"string","description":"The name of the API key group"},"id":{"type":"integer","description":"The unique identifier of the API key group","format":"int64","readOnly":true},"apiPolicyApiKeyGroupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignmentViewModel"},"description":"The API group assignments","readOnly":true}},"additionalProperties":false},"ApiPolicyApiKeyGroupAssignmentViewModel":{"required":["apiKey"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the assignment","format":"int64"},"apiKey":{"$ref":"#/components/schemas/ApiKeyViewModel"}},"additionalProperties":false},"ApiKeyViewModel":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string","nullable":true},"environment":{"type":"string","nullable":true},"value":{"type":"string","format":"uuid"}},"additionalProperties":false}}}}
```

## The ApiPolicyApiKeySaveModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPolicyApiKeySaveModel":{"type":"object","properties":{"id":{"type":"integer","description":"The API key identifier","format":"int64"}},"additionalProperties":false}}}}
```

## The ApiPolicyDeploymentSaveModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPolicyDeploymentSaveModel":{"required":["agentGroupName"],"type":"object","properties":{"agentGroupName":{"type":"string","description":"The Agent Group associated with the deployment"}},"additionalProperties":false}}}}
```

## The ApiPolicyDeploymentViewModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPolicyDeploymentViewModel":{"required":["agentGroupName"],"type":"object","properties":{"agentGroupName":{"type":"string","description":"The Agent Group associated with the deployment"},"id":{"type":"integer","description":"The unique identifier of the deployment","format":"int64","readOnly":true},"deployerUserName":{"type":"string","description":"The username of the deployer"},"deployedUtc":{"type":"string","description":"The timestamp when the deployment occurred","format":"date-time"}},"additionalProperties":false}}}}
```

## The ApiPolicyIdentityRuleSaveModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPolicyIdentityRuleSaveModel":{"required":["claim"],"type":"object","properties":{"ruleType":{"$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":"string","description":"The claim associated with the identity rule"},"value":{"type":"string","description":"The value associated with the identity rule","nullable":true},"matchType":{"$ref":"#/components/schemas/IdentityRuleMatchType"}},"additionalProperties":false},"ApiAccessRuleType":{"enum":["Allow","Deny"],"type":"string"},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"],"type":"string"}}}}
```

## The ApiPolicyIdentityRuleViewModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPolicyIdentityRuleViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier of the identity rule","format":"int64","readOnly":true},"ruleType":{"$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":"string","description":"The claim associated with the identity rule","readOnly":true},"value":{"type":"string","description":"The value associated with the identity rule","readOnly":true},"matchType":{"$ref":"#/components/schemas/IdentityRuleMatchType"}},"additionalProperties":false},"ApiAccessRuleType":{"enum":["Allow","Deny"],"type":"string"},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"],"type":"string"}}}}
```

## The ApiPolicyIdentitySaveModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPolicyIdentitySaveModel":{"required":["deployments","issuers","name"],"type":"object","properties":{"requestLimit":{"type":"integer","description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32","nullable":true},"requestLimitWindowInMinutes":{"type":"integer","description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32","nullable":true},"isPrivateApplication":{"type":"boolean","description":"Determines if it is a private application"},"issuers":{"type":"array","items":{"type":"string"},"description":"The issuers of the identity"},"name":{"type":"string","description":"The name of the identity"},"throttlingByClaim":{"type":"string","description":"The throttling by claim for the identity","nullable":true},"priorityNumber":{"type":"integer","description":"In case of 2 or more matching identities, determines which identity to use. Lower number will be selected.","format":"int32"},"id":{"type":"integer","description":"The unique identifier of the identity. Only provide a value when updating.","format":"int64","nullable":true},"identityRules":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyIdentityRuleSaveModel"},"description":"The list of identity rules","nullable":true},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyDeploymentSaveModel"},"description":"The list of deployments associated with the identity"}},"additionalProperties":false},"ApiPolicyIdentityRuleSaveModel":{"required":["claim"],"type":"object","properties":{"ruleType":{"$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":"string","description":"The claim associated with the identity rule"},"value":{"type":"string","description":"The value associated with the identity rule","nullable":true},"matchType":{"$ref":"#/components/schemas/IdentityRuleMatchType"}},"additionalProperties":false},"ApiAccessRuleType":{"enum":["Allow","Deny"],"type":"string"},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"],"type":"string"},"ApiPolicyDeploymentSaveModel":{"required":["agentGroupName"],"type":"object","properties":{"agentGroupName":{"type":"string","description":"The Agent Group associated with the deployment"}},"additionalProperties":false}}}}
```

## The ApiPolicyIdentityViewModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPolicyIdentityViewModel":{"required":["issuers","name"],"type":"object","properties":{"requestLimit":{"type":"integer","description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32","nullable":true},"requestLimitWindowInMinutes":{"type":"integer","description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32","nullable":true},"isPrivateApplication":{"type":"boolean","description":"Determines if it is a private application"},"issuers":{"type":"array","items":{"type":"string"},"description":"The issuers of the identity"},"name":{"type":"string","description":"The name of the identity"},"throttlingByClaim":{"type":"string","description":"The throttling by claim for the identity","nullable":true},"priorityNumber":{"type":"integer","description":"In case of 2 or more matching identities, determines which identity to use. Lower number will be selected.","format":"int32"},"id":{"type":"integer","description":"The unique identifier of the identity","format":"int64","readOnly":true},"identityRules":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyIdentityRuleViewModel"}},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyDeploymentViewModel"},"description":"The list of deployments associated with the identity"}},"additionalProperties":false},"ApiPolicyIdentityRuleViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier of the identity rule","format":"int64","readOnly":true},"ruleType":{"$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":"string","description":"The claim associated with the identity rule","readOnly":true},"value":{"type":"string","description":"The value associated with the identity rule","readOnly":true},"matchType":{"$ref":"#/components/schemas/IdentityRuleMatchType"}},"additionalProperties":false},"ApiAccessRuleType":{"enum":["Allow","Deny"],"type":"string"},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"],"type":"string"},"ApiPolicyDeploymentViewModel":{"required":["agentGroupName"],"type":"object","properties":{"agentGroupName":{"type":"string","description":"The Agent Group associated with the deployment"},"id":{"type":"integer","description":"The unique identifier of the deployment","format":"int64","readOnly":true},"deployerUserName":{"type":"string","description":"The username of the deployer"},"deployedUtc":{"type":"string","description":"The timestamp when the deployment occurred","format":"date-time"}},"additionalProperties":false}}}}
```

## The ApiPolicyListItemViewModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPolicyListItemViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier of the API policy","format":"int64","readOnly":true},"name":{"type":"string","description":"The name of the policy"},"description":{"type":"string","description":"The description of the policy","nullable":true}},"additionalProperties":false}}}}
```

## The ApiPolicyListItemViewModelIEnumerableResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPolicyListItemViewModelIEnumerableResponse":{"required":["Data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyListItemViewModel"},"description":"Response data","nullable":true}},"additionalProperties":false},"ApiPolicyListItemViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier of the API policy","format":"int64","readOnly":true},"name":{"type":"string","description":"The name of the policy"},"description":{"type":"string","description":"The description of the policy","nullable":true}},"additionalProperties":false}}}}
```

## The ApiPolicyRequestLoggingSaveModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPolicyRequestLoggingSaveModel":{"required":["deployments","loggingFields","name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the request logging"},"loggingFields":{"type":"array","items":{"type":"string"},"description":"The fields logged by request logging"},"ipLogging":{"$ref":"#/components/schemas/IpLoggingType"},"requestBodyMaxLengthKb":{"type":"integer","description":"Request body maximum length for request logging","format":"int32"},"responseBodyMaxLengthKb":{"type":"integer","description":"Response body maximum length for request logging","format":"int32"},"disableLogging":{"type":"boolean","description":"Disable logging for request logging"},"id":{"type":"integer","description":"The unique identifier of the request logging. Only provide a value when updating.","format":"int64","nullable":true},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyDeploymentSaveModel"},"description":"The list of deployments associated with the request logging"}},"additionalProperties":false},"IpLoggingType":{"enum":["ClientIP","ClientIPXForwardedForFirst","ClientIPXForwardedForAll","Disable"],"type":"string"},"ApiPolicyDeploymentSaveModel":{"required":["agentGroupName"],"type":"object","properties":{"agentGroupName":{"type":"string","description":"The Agent Group associated with the deployment"}},"additionalProperties":false}}}}
```

## The ApiPolicyRequestLoggingViewModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPolicyRequestLoggingViewModel":{"required":["loggingFields","name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the request logging"},"loggingFields":{"type":"array","items":{"type":"string"},"description":"The fields logged by request logging"},"ipLogging":{"$ref":"#/components/schemas/IpLoggingType"},"requestBodyMaxLengthKb":{"type":"integer","description":"Request body maximum length for request logging","format":"int32"},"responseBodyMaxLengthKb":{"type":"integer","description":"Response body maximum length for request logging","format":"int32"},"disableLogging":{"type":"boolean","description":"Disable logging for request logging"},"id":{"type":"integer","description":"The unique identifier of the request logging","format":"int64","readOnly":true},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyDeploymentViewModel"},"description":"The list of deployments associated with the request logging"}},"additionalProperties":false},"IpLoggingType":{"enum":["ClientIP","ClientIPXForwardedForFirst","ClientIPXForwardedForAll","Disable"],"type":"string"},"ApiPolicyDeploymentViewModel":{"required":["agentGroupName"],"type":"object","properties":{"agentGroupName":{"type":"string","description":"The Agent Group associated with the deployment"},"id":{"type":"integer","description":"The unique identifier of the deployment","format":"int64","readOnly":true},"deployerUserName":{"type":"string","description":"The username of the deployer"},"deployedUtc":{"type":"string","description":"The timestamp when the deployment occurred","format":"date-time"}},"additionalProperties":false}}}}
```

## The ApiPolicySaveModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPolicySaveModel":{"required":["name","targetEndpoints"],"type":"object","properties":{"name":{"type":"string","description":"The name of the policy"},"description":{"type":"string","description":"The description of the policy","nullable":true},"tags":{"type":"array","items":{"type":"string"},"description":"The tags of the policy","nullable":true},"allowPublicAccess":{"type":"boolean","description":"Determines if public access is allowed"},"apiKeyName":{"type":"string","description":"The name of the API key"},"apiKeyLocation":{"$ref":"#/components/schemas/ParameterLocation"},"targetEndpoints":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyTargetEndpointSaveModel"},"description":"The list of target endpoints associated with the policy"},"identities":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyIdentitySaveModel"},"description":"The list of identities associated with the policy","nullable":true},"apiKeyGroups":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupSaveModel"},"description":"The list of API key groups associated with the policy","nullable":true},"publicAccessDeployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyDeploymentSaveModel"},"description":"The list of deployments associated with the public access identity","nullable":true},"requestLoggingOptions":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLoggingSaveModel"},"description":"The list of request logging options associated with the api policy","nullable":true}},"additionalProperties":false},"ParameterLocation":{"enum":["Query","Header","Path","Cookie"],"type":"string"},"ApiPolicyTargetEndpointSaveModel":{"required":["path"],"type":"object","properties":{"requestLimit":{"type":"integer","description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32","nullable":true},"requestLimitWindowInMinutes":{"type":"integer","description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32","nullable":true},"path":{"type":"string","description":"The path of the target endpoint"},"method":{"$ref":"#/components/schemas/PolicyEndpointMethod"}},"additionalProperties":false},"PolicyEndpointMethod":{"enum":["All","Get","Post","Put","Head","Delete","Patch","Options","Connect","Trace"],"type":"string"},"ApiPolicyIdentitySaveModel":{"required":["deployments","issuers","name"],"type":"object","properties":{"requestLimit":{"type":"integer","description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32","nullable":true},"requestLimitWindowInMinutes":{"type":"integer","description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32","nullable":true},"isPrivateApplication":{"type":"boolean","description":"Determines if it is a private application"},"issuers":{"type":"array","items":{"type":"string"},"description":"The issuers of the identity"},"name":{"type":"string","description":"The name of the identity"},"throttlingByClaim":{"type":"string","description":"The throttling by claim for the identity","nullable":true},"priorityNumber":{"type":"integer","description":"In case of 2 or more matching identities, determines which identity to use. Lower number will be selected.","format":"int32"},"id":{"type":"integer","description":"The unique identifier of the identity. Only provide a value when updating.","format":"int64","nullable":true},"identityRules":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyIdentityRuleSaveModel"},"description":"The list of identity rules","nullable":true},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyDeploymentSaveModel"},"description":"The list of deployments associated with the identity"}},"additionalProperties":false},"ApiPolicyIdentityRuleSaveModel":{"required":["claim"],"type":"object","properties":{"ruleType":{"$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":"string","description":"The claim associated with the identity rule"},"value":{"type":"string","description":"The value associated with the identity rule","nullable":true},"matchType":{"$ref":"#/components/schemas/IdentityRuleMatchType"}},"additionalProperties":false},"ApiAccessRuleType":{"enum":["Allow","Deny"],"type":"string"},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"],"type":"string"},"ApiPolicyDeploymentSaveModel":{"required":["agentGroupName"],"type":"object","properties":{"agentGroupName":{"type":"string","description":"The Agent Group associated with the deployment"}},"additionalProperties":false},"ApiPolicyApiKeyGroupSaveModel":{"required":["apiPolicyApiKeyGroupAssignments","name"],"type":"object","properties":{"requestLimit":{"type":"integer","description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32","nullable":true},"requestLimitWindowInMinutes":{"type":"integer","description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32","nullable":true},"name":{"type":"string","description":"The name of the API key group"},"apiPolicyApiKeyGroupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignmentSaveModel"},"description":"The API key group assignments"}},"additionalProperties":false},"ApiPolicyApiKeyGroupAssignmentSaveModel":{"required":["apiKey"],"type":"object","properties":{"apiKey":{"$ref":"#/components/schemas/ApiPolicyApiKeySaveModel"}},"additionalProperties":false},"ApiPolicyApiKeySaveModel":{"type":"object","properties":{"id":{"type":"integer","description":"The API key identifier","format":"int64"}},"additionalProperties":false},"ApiPolicyRequestLoggingSaveModel":{"required":["deployments","loggingFields","name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the request logging"},"loggingFields":{"type":"array","items":{"type":"string"},"description":"The fields logged by request logging"},"ipLogging":{"$ref":"#/components/schemas/IpLoggingType"},"requestBodyMaxLengthKb":{"type":"integer","description":"Request body maximum length for request logging","format":"int32"},"responseBodyMaxLengthKb":{"type":"integer","description":"Response body maximum length for request logging","format":"int32"},"disableLogging":{"type":"boolean","description":"Disable logging for request logging"},"id":{"type":"integer","description":"The unique identifier of the request logging. Only provide a value when updating.","format":"int64","nullable":true},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyDeploymentSaveModel"},"description":"The list of deployments associated with the request logging"}},"additionalProperties":false},"IpLoggingType":{"enum":["ClientIP","ClientIPXForwardedForFirst","ClientIPXForwardedForAll","Disable"],"type":"string"}}}}
```

## The ApiPolicyTargetEndpointSaveModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPolicyTargetEndpointSaveModel":{"required":["path"],"type":"object","properties":{"requestLimit":{"type":"integer","description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32","nullable":true},"requestLimitWindowInMinutes":{"type":"integer","description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32","nullable":true},"path":{"type":"string","description":"The path of the target endpoint"},"method":{"$ref":"#/components/schemas/PolicyEndpointMethod"}},"additionalProperties":false},"PolicyEndpointMethod":{"enum":["All","Get","Post","Put","Head","Delete","Patch","Options","Connect","Trace"],"type":"string"}}}}
```

## The ApiPolicyTargetEndpointViewModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPolicyTargetEndpointViewModel":{"required":["path"],"type":"object","properties":{"requestLimit":{"type":"integer","description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32","nullable":true},"requestLimitWindowInMinutes":{"type":"integer","description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32","nullable":true},"path":{"type":"string","description":"The path of the target endpoint"},"method":{"$ref":"#/components/schemas/PolicyEndpointMethod"},"id":{"type":"integer","description":"The unique identifier of the target endpoint","format":"int64","readOnly":true}},"additionalProperties":false},"PolicyEndpointMethod":{"enum":["All","Get","Post","Put","Head","Delete","Patch","Options","Connect","Trace"],"type":"string"}}}}
```

## The ApiPolicyViewModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPolicyViewModel":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the policy"},"description":{"type":"string","description":"The description of the policy","nullable":true},"tags":{"type":"array","items":{"type":"string"},"description":"The tags of the policy","nullable":true},"allowPublicAccess":{"type":"boolean","description":"Determines if public access is allowed"},"apiKeyName":{"type":"string","description":"The name of the API key"},"apiKeyLocation":{"$ref":"#/components/schemas/ParameterLocation"},"id":{"type":"integer","description":"The identifier of the policy","format":"int64","readOnly":true},"uniqueIdentifier":{"type":"string","description":"The globally unique identifier of the policy","format":"uuid","readOnly":true},"modifier":{"type":"string","description":"The modifier of the policy","readOnly":true},"modifiedUtc":{"type":"string","description":"The timestamp when the policy was last modified","format":"date-time","readOnly":true},"targetEndpoints":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyTargetEndpointViewModel"},"description":"The list of target endpoints associated with the policy","readOnly":true},"identities":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyIdentityViewModel"},"description":"The list of identities associated with the policy","readOnly":true},"apiKeyGroups":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupViewModel"},"description":"The list of API key groups associated with the policy","readOnly":true},"publicAccessDeployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyDeploymentViewModel"},"description":"The list of deployments connected with public access identity","readOnly":true},"requestLoggingOptions":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLoggingViewModel"},"description":"The list of request logging options associated with the api policy","readOnly":true}},"additionalProperties":false},"ParameterLocation":{"enum":["Query","Header","Path","Cookie"],"type":"string"},"ApiPolicyTargetEndpointViewModel":{"required":["path"],"type":"object","properties":{"requestLimit":{"type":"integer","description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32","nullable":true},"requestLimitWindowInMinutes":{"type":"integer","description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32","nullable":true},"path":{"type":"string","description":"The path of the target endpoint"},"method":{"$ref":"#/components/schemas/PolicyEndpointMethod"},"id":{"type":"integer","description":"The unique identifier of the target endpoint","format":"int64","readOnly":true}},"additionalProperties":false},"PolicyEndpointMethod":{"enum":["All","Get","Post","Put","Head","Delete","Patch","Options","Connect","Trace"],"type":"string"},"ApiPolicyIdentityViewModel":{"required":["issuers","name"],"type":"object","properties":{"requestLimit":{"type":"integer","description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32","nullable":true},"requestLimitWindowInMinutes":{"type":"integer","description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32","nullable":true},"isPrivateApplication":{"type":"boolean","description":"Determines if it is a private application"},"issuers":{"type":"array","items":{"type":"string"},"description":"The issuers of the identity"},"name":{"type":"string","description":"The name of the identity"},"throttlingByClaim":{"type":"string","description":"The throttling by claim for the identity","nullable":true},"priorityNumber":{"type":"integer","description":"In case of 2 or more matching identities, determines which identity to use. Lower number will be selected.","format":"int32"},"id":{"type":"integer","description":"The unique identifier of the identity","format":"int64","readOnly":true},"identityRules":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyIdentityRuleViewModel"}},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyDeploymentViewModel"},"description":"The list of deployments associated with the identity"}},"additionalProperties":false},"ApiPolicyIdentityRuleViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier of the identity rule","format":"int64","readOnly":true},"ruleType":{"$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":"string","description":"The claim associated with the identity rule","readOnly":true},"value":{"type":"string","description":"The value associated with the identity rule","readOnly":true},"matchType":{"$ref":"#/components/schemas/IdentityRuleMatchType"}},"additionalProperties":false},"ApiAccessRuleType":{"enum":["Allow","Deny"],"type":"string"},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"],"type":"string"},"ApiPolicyDeploymentViewModel":{"required":["agentGroupName"],"type":"object","properties":{"agentGroupName":{"type":"string","description":"The Agent Group associated with the deployment"},"id":{"type":"integer","description":"The unique identifier of the deployment","format":"int64","readOnly":true},"deployerUserName":{"type":"string","description":"The username of the deployer"},"deployedUtc":{"type":"string","description":"The timestamp when the deployment occurred","format":"date-time"}},"additionalProperties":false},"ApiPolicyApiKeyGroupViewModel":{"required":["name"],"type":"object","properties":{"requestLimit":{"type":"integer","description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32","nullable":true},"requestLimitWindowInMinutes":{"type":"integer","description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32","nullable":true},"name":{"type":"string","description":"The name of the API key group"},"id":{"type":"integer","description":"The unique identifier of the API key group","format":"int64","readOnly":true},"apiPolicyApiKeyGroupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignmentViewModel"},"description":"The API group assignments","readOnly":true}},"additionalProperties":false},"ApiPolicyApiKeyGroupAssignmentViewModel":{"required":["apiKey"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the assignment","format":"int64"},"apiKey":{"$ref":"#/components/schemas/ApiKeyViewModel"}},"additionalProperties":false},"ApiKeyViewModel":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string","nullable":true},"environment":{"type":"string","nullable":true},"value":{"type":"string","format":"uuid"}},"additionalProperties":false},"ApiPolicyRequestLoggingViewModel":{"required":["loggingFields","name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the request logging"},"loggingFields":{"type":"array","items":{"type":"string"},"description":"The fields logged by request logging"},"ipLogging":{"$ref":"#/components/schemas/IpLoggingType"},"requestBodyMaxLengthKb":{"type":"integer","description":"Request body maximum length for request logging","format":"int32"},"responseBodyMaxLengthKb":{"type":"integer","description":"Response body maximum length for request logging","format":"int32"},"disableLogging":{"type":"boolean","description":"Disable logging for request logging"},"id":{"type":"integer","description":"The unique identifier of the request logging","format":"int64","readOnly":true},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyDeploymentViewModel"},"description":"The list of deployments associated with the request logging"}},"additionalProperties":false},"IpLoggingType":{"enum":["ClientIP","ClientIPXForwardedForFirst","ClientIPXForwardedForAll","Disable"],"type":"string"}}}}
```

## The ApiPolicyViewModelResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiPolicyViewModelResponse":{"required":["Data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/ApiPolicyViewModel"}},"additionalProperties":false},"ApiPolicyViewModel":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the policy"},"description":{"type":"string","description":"The description of the policy","nullable":true},"tags":{"type":"array","items":{"type":"string"},"description":"The tags of the policy","nullable":true},"allowPublicAccess":{"type":"boolean","description":"Determines if public access is allowed"},"apiKeyName":{"type":"string","description":"The name of the API key"},"apiKeyLocation":{"$ref":"#/components/schemas/ParameterLocation"},"id":{"type":"integer","description":"The identifier of the policy","format":"int64","readOnly":true},"uniqueIdentifier":{"type":"string","description":"The globally unique identifier of the policy","format":"uuid","readOnly":true},"modifier":{"type":"string","description":"The modifier of the policy","readOnly":true},"modifiedUtc":{"type":"string","description":"The timestamp when the policy was last modified","format":"date-time","readOnly":true},"targetEndpoints":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyTargetEndpointViewModel"},"description":"The list of target endpoints associated with the policy","readOnly":true},"identities":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyIdentityViewModel"},"description":"The list of identities associated with the policy","readOnly":true},"apiKeyGroups":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupViewModel"},"description":"The list of API key groups associated with the policy","readOnly":true},"publicAccessDeployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyDeploymentViewModel"},"description":"The list of deployments connected with public access identity","readOnly":true},"requestLoggingOptions":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLoggingViewModel"},"description":"The list of request logging options associated with the api policy","readOnly":true}},"additionalProperties":false},"ParameterLocation":{"enum":["Query","Header","Path","Cookie"],"type":"string"},"ApiPolicyTargetEndpointViewModel":{"required":["path"],"type":"object","properties":{"requestLimit":{"type":"integer","description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32","nullable":true},"requestLimitWindowInMinutes":{"type":"integer","description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32","nullable":true},"path":{"type":"string","description":"The path of the target endpoint"},"method":{"$ref":"#/components/schemas/PolicyEndpointMethod"},"id":{"type":"integer","description":"The unique identifier of the target endpoint","format":"int64","readOnly":true}},"additionalProperties":false},"PolicyEndpointMethod":{"enum":["All","Get","Post","Put","Head","Delete","Patch","Options","Connect","Trace"],"type":"string"},"ApiPolicyIdentityViewModel":{"required":["issuers","name"],"type":"object","properties":{"requestLimit":{"type":"integer","description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32","nullable":true},"requestLimitWindowInMinutes":{"type":"integer","description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32","nullable":true},"isPrivateApplication":{"type":"boolean","description":"Determines if it is a private application"},"issuers":{"type":"array","items":{"type":"string"},"description":"The issuers of the identity"},"name":{"type":"string","description":"The name of the identity"},"throttlingByClaim":{"type":"string","description":"The throttling by claim for the identity","nullable":true},"priorityNumber":{"type":"integer","description":"In case of 2 or more matching identities, determines which identity to use. Lower number will be selected.","format":"int32"},"id":{"type":"integer","description":"The unique identifier of the identity","format":"int64","readOnly":true},"identityRules":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyIdentityRuleViewModel"}},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyDeploymentViewModel"},"description":"The list of deployments associated with the identity"}},"additionalProperties":false},"ApiPolicyIdentityRuleViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier of the identity rule","format":"int64","readOnly":true},"ruleType":{"$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":"string","description":"The claim associated with the identity rule","readOnly":true},"value":{"type":"string","description":"The value associated with the identity rule","readOnly":true},"matchType":{"$ref":"#/components/schemas/IdentityRuleMatchType"}},"additionalProperties":false},"ApiAccessRuleType":{"enum":["Allow","Deny"],"type":"string"},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"],"type":"string"},"ApiPolicyDeploymentViewModel":{"required":["agentGroupName"],"type":"object","properties":{"agentGroupName":{"type":"string","description":"The Agent Group associated with the deployment"},"id":{"type":"integer","description":"The unique identifier of the deployment","format":"int64","readOnly":true},"deployerUserName":{"type":"string","description":"The username of the deployer"},"deployedUtc":{"type":"string","description":"The timestamp when the deployment occurred","format":"date-time"}},"additionalProperties":false},"ApiPolicyApiKeyGroupViewModel":{"required":["name"],"type":"object","properties":{"requestLimit":{"type":"integer","description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32","nullable":true},"requestLimitWindowInMinutes":{"type":"integer","description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32","nullable":true},"name":{"type":"string","description":"The name of the API key group"},"id":{"type":"integer","description":"The unique identifier of the API key group","format":"int64","readOnly":true},"apiPolicyApiKeyGroupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignmentViewModel"},"description":"The API group assignments","readOnly":true}},"additionalProperties":false},"ApiPolicyApiKeyGroupAssignmentViewModel":{"required":["apiKey"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the assignment","format":"int64"},"apiKey":{"$ref":"#/components/schemas/ApiKeyViewModel"}},"additionalProperties":false},"ApiKeyViewModel":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string","nullable":true},"environment":{"type":"string","nullable":true},"value":{"type":"string","format":"uuid"}},"additionalProperties":false},"ApiPolicyRequestLoggingViewModel":{"required":["loggingFields","name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the request logging"},"loggingFields":{"type":"array","items":{"type":"string"},"description":"The fields logged by request logging"},"ipLogging":{"$ref":"#/components/schemas/IpLoggingType"},"requestBodyMaxLengthKb":{"type":"integer","description":"Request body maximum length for request logging","format":"int32"},"responseBodyMaxLengthKb":{"type":"integer","description":"Response body maximum length for request logging","format":"int32"},"disableLogging":{"type":"boolean","description":"Disable logging for request logging"},"id":{"type":"integer","description":"The unique identifier of the request logging","format":"int64","readOnly":true},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyDeploymentViewModel"},"description":"The list of deployments associated with the request logging"}},"additionalProperties":false},"IpLoggingType":{"enum":["ClientIP","ClientIPXForwardedForFirst","ClientIPXForwardedForAll","Disable"],"type":"string"}}}}
```

## The ApiProcessTemplateRequest object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ApiProcessTemplateRequest":{"required":["Operation","Path"],"type":"object","properties":{"path":{"type":"string","description":"The path of the HTTP endpoint, as specified in the API specification"},"operation":{"type":"string","description":"The operation of the endpoint (e.g. GET)"}},"additionalProperties":false}}}}
```

## The CommentInstancesQueryModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"CommentInstancesQueryModel":{"required":["comment","instanceIds"],"type":"object","properties":{"comment":{"type":"string"},"processGuids":{"type":"array","items":{"type":"string","format":"uuid"},"nullable":true},"instanceIds":{"type":"array","items":{"type":"integer","format":"int64"}}},"additionalProperties":false}}}}
```

## The CreateProcessFromTemplateRequestBody object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"CreateProcessFromTemplateRequestBody":{"required":["IgnoreProcessTags"],"type":"object","properties":{"name":{"minLength":1,"type":"string","description":"Element name"},"description":{"type":"string","description":"Element description","nullable":true},"processVariables":{"type":"array","items":{"$ref":"#/components/schemas/ProcessVariable"},"nullable":true},"ignoreProcessTags":{"type":"boolean","description":"If true the Process will not be created with the predefined tags"}},"additionalProperties":false},"ProcessVariable":{"type":"object","properties":{"name":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"isSecret":{"type":"boolean"},"mode":{"type":"string","nullable":true},"description":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The CreateTemplateFromProcessRequestBody object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"CreateTemplateFromProcessRequestBody":{"required":["ProcessId"],"type":"object","properties":{"name":{"minLength":1,"type":"string","description":"Element name"},"description":{"type":"string","description":"Element description","nullable":true},"processVariables":{"type":"array","items":{"$ref":"#/components/schemas/ProcessVariable"},"nullable":true},"processId":{"type":"integer","description":"Process id","format":"int64"},"guid":{"type":"string","format":"uuid"},"templateMajorVersion":{"type":"integer","description":"Templates major version","format":"int32","nullable":true},"templateMinorVersion":{"type":"integer","description":"Templates minor version","format":"int32","nullable":true},"templateTags":{"type":"array","items":{"type":"string"},"description":"Tags for the Process template","nullable":true},"processTags":{"type":"array","items":{"type":"string"},"description":"Predefined tags for Processes created from the template","nullable":true},"linkProcessToCreatedTemplate":{"type":"boolean","description":"Link the Process to the created Template","nullable":true}},"additionalProperties":false},"ProcessVariable":{"type":"object","properties":{"name":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"isSecret":{"type":"boolean"},"mode":{"type":"string","nullable":true},"description":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The DtoAgentGet object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoAgentGet":{"required":["IsCloudAgent","IsGateway","Name"],"type":"object","properties":{"url":{"type":"string","description":"The hostname or address for the agent. Can either be full URL https://example.org:1234 or hostname subdomain.example.org","readOnly":true},"httpPorts":{"type":"array","items":{"type":"string"},"description":"List of http ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored.","readOnly":true},"httpsPorts":{"type":"array","items":{"type":"string"},"description":"List of https ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored.","readOnly":true},"id":{"type":"integer","description":"Agent Identifier","format":"int64"},"name":{"type":"string","description":"Agent name","readOnly":true},"isGateway":{"type":"boolean","description":"If the agent is a Gateway Agent. If true, these Agents are the ones that should primarily be accessible from the internet.","readOnly":true},"isCloudAgent":{"type":"boolean","description":"If the agent is a Cloud Agent. If true, these Agents are managed by Frends.","readOnly":true}},"additionalProperties":false}}}}
```

## The DtoAgentGroupBase object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoAgentGroupBase":{"required":["DisplayName","Id"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Agent Group","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Agent Group","readOnly":true}},"additionalProperties":false}}}}
```

## The DtoAgentGroupGet object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoAgentGroupGet":{"required":["Agents","Environment","InternalName","IsCrossPlatform"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Agent Group","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Agent Group","readOnly":true},"internalName":{"type":"string","description":"Internal name used by Frends for the Agent Group","readOnly":true},"isCrossPlatform":{"type":"boolean","description":"Indicates whether the Agents in the group can be installed on Windows and Linux machines","readOnly":true},"agents":{"type":"array","items":{"type":"string"},"description":"The Agents that belong to the Agent Group","readOnly":true},"environment":{"$ref":"#/components/schemas/DtoEnvironmentBase"},"agentDetails":{"type":"array","items":{"$ref":"#/components/schemas/DtoAgentGet"},"description":"Details about the Agents that belong to the Agent Group","readOnly":true}},"additionalProperties":false},"DtoEnvironmentBase":{"required":["DisplayName","Id"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Environment","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Environment","readOnly":true}},"additionalProperties":false},"DtoAgentGet":{"required":["IsCloudAgent","IsGateway","Name"],"type":"object","properties":{"url":{"type":"string","description":"The hostname or address for the agent. Can either be full URL https://example.org:1234 or hostname subdomain.example.org","readOnly":true},"httpPorts":{"type":"array","items":{"type":"string"},"description":"List of http ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored.","readOnly":true},"httpsPorts":{"type":"array","items":{"type":"string"},"description":"List of https ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored.","readOnly":true},"id":{"type":"integer","description":"Agent Identifier","format":"int64"},"name":{"type":"string","description":"Agent name","readOnly":true},"isGateway":{"type":"boolean","description":"If the agent is a Gateway Agent. If true, these Agents are the ones that should primarily be accessible from the internet.","readOnly":true},"isCloudAgent":{"type":"boolean","description":"If the agent is a Cloud Agent. If true, these Agents are managed by Frends.","readOnly":true}},"additionalProperties":false}}}}
```

## The DtoAgentGroupGetIListResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoAgentGroupGetIListResponse":{"required":["Data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DtoAgentGroupGet"},"description":"Response data","nullable":true}},"additionalProperties":false},"DtoAgentGroupGet":{"required":["Agents","Environment","InternalName","IsCrossPlatform"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Agent Group","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Agent Group","readOnly":true},"internalName":{"type":"string","description":"Internal name used by Frends for the Agent Group","readOnly":true},"isCrossPlatform":{"type":"boolean","description":"Indicates whether the Agents in the group can be installed on Windows and Linux machines","readOnly":true},"agents":{"type":"array","items":{"type":"string"},"description":"The Agents that belong to the Agent Group","readOnly":true},"environment":{"$ref":"#/components/schemas/DtoEnvironmentBase"},"agentDetails":{"type":"array","items":{"$ref":"#/components/schemas/DtoAgentGet"},"description":"Details about the Agents that belong to the Agent Group","readOnly":true}},"additionalProperties":false},"DtoEnvironmentBase":{"required":["DisplayName","Id"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Environment","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Environment","readOnly":true}},"additionalProperties":false},"DtoAgentGet":{"required":["IsCloudAgent","IsGateway","Name"],"type":"object","properties":{"url":{"type":"string","description":"The hostname or address for the agent. Can either be full URL https://example.org:1234 or hostname subdomain.example.org","readOnly":true},"httpPorts":{"type":"array","items":{"type":"string"},"description":"List of http ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored.","readOnly":true},"httpsPorts":{"type":"array","items":{"type":"string"},"description":"List of https ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored.","readOnly":true},"id":{"type":"integer","description":"Agent Identifier","format":"int64"},"name":{"type":"string","description":"Agent name","readOnly":true},"isGateway":{"type":"boolean","description":"If the agent is a Gateway Agent. If true, these Agents are the ones that should primarily be accessible from the internet.","readOnly":true},"isCloudAgent":{"type":"boolean","description":"If the agent is a Cloud Agent. If true, these Agents are managed by Frends.","readOnly":true}},"additionalProperties":false}}}}
```

## The DtoAgentGroupGetResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoAgentGroupGetResponse":{"required":["Data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/DtoAgentGroupGet"}},"additionalProperties":false},"DtoAgentGroupGet":{"required":["Agents","Environment","InternalName","IsCrossPlatform"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Agent Group","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Agent Group","readOnly":true},"internalName":{"type":"string","description":"Internal name used by Frends for the Agent Group","readOnly":true},"isCrossPlatform":{"type":"boolean","description":"Indicates whether the Agents in the group can be installed on Windows and Linux machines","readOnly":true},"agents":{"type":"array","items":{"type":"string"},"description":"The Agents that belong to the Agent Group","readOnly":true},"environment":{"$ref":"#/components/schemas/DtoEnvironmentBase"},"agentDetails":{"type":"array","items":{"$ref":"#/components/schemas/DtoAgentGet"},"description":"Details about the Agents that belong to the Agent Group","readOnly":true}},"additionalProperties":false},"DtoEnvironmentBase":{"required":["DisplayName","Id"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Environment","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Environment","readOnly":true}},"additionalProperties":false},"DtoAgentGet":{"required":["IsCloudAgent","IsGateway","Name"],"type":"object","properties":{"url":{"type":"string","description":"The hostname or address for the agent. Can either be full URL https://example.org:1234 or hostname subdomain.example.org","readOnly":true},"httpPorts":{"type":"array","items":{"type":"string"},"description":"List of http ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored.","readOnly":true},"httpsPorts":{"type":"array","items":{"type":"string"},"description":"List of https ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored.","readOnly":true},"id":{"type":"integer","description":"Agent Identifier","format":"int64"},"name":{"type":"string","description":"Agent name","readOnly":true},"isGateway":{"type":"boolean","description":"If the agent is a Gateway Agent. If true, these Agents are the ones that should primarily be accessible from the internet.","readOnly":true},"isCloudAgent":{"type":"boolean","description":"If the agent is a Cloud Agent. If true, these Agents are managed by Frends.","readOnly":true}},"additionalProperties":false}}}}
```

## The DtoAgentStatusGet object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoAgentStatusGet":{"required":["IsCloudAgent","IsGateway","Name"],"type":"object","properties":{"url":{"type":"string","description":"The hostname or address for the agent. Can either be full URL https://example.org:1234 or hostname subdomain.example.org","readOnly":true},"httpPorts":{"type":"array","items":{"type":"string"},"description":"List of http ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored.","readOnly":true},"httpsPorts":{"type":"array","items":{"type":"string"},"description":"List of https ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored.","readOnly":true},"id":{"type":"integer","description":"Agent Identifier","format":"int64"},"name":{"type":"string","description":"Agent name","readOnly":true},"isGateway":{"type":"boolean","description":"If the agent is a Gateway Agent. If true, these Agents are the ones that should primarily be accessible from the internet.","readOnly":true},"isCloudAgent":{"type":"boolean","description":"If the agent is a Cloud Agent. If true, these Agents are managed by Frends.","readOnly":true},"lastError":{"type":"string","description":"Date&Time of the last error occurred.","format":"date-time","nullable":true,"readOnly":true},"lastUpdate":{"type":"string","description":"Date&Time of the last agent update occurred.","format":"date-time","nullable":true,"readOnly":true},"lastStatus":{"type":"string","description":"Last known Agent status.","nullable":true,"readOnly":true}},"additionalProperties":false}}}}
```

## The DtoAgentStatusGetResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoAgentStatusGetResponse":{"required":["Data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/DtoAgentStatusGet"}},"additionalProperties":false},"DtoAgentStatusGet":{"required":["IsCloudAgent","IsGateway","Name"],"type":"object","properties":{"url":{"type":"string","description":"The hostname or address for the agent. Can either be full URL https://example.org:1234 or hostname subdomain.example.org","readOnly":true},"httpPorts":{"type":"array","items":{"type":"string"},"description":"List of http ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored.","readOnly":true},"httpsPorts":{"type":"array","items":{"type":"string"},"description":"List of https ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored.","readOnly":true},"id":{"type":"integer","description":"Agent Identifier","format":"int64"},"name":{"type":"string","description":"Agent name","readOnly":true},"isGateway":{"type":"boolean","description":"If the agent is a Gateway Agent. If true, these Agents are the ones that should primarily be accessible from the internet.","readOnly":true},"isCloudAgent":{"type":"boolean","description":"If the agent is a Cloud Agent. If true, these Agents are managed by Frends.","readOnly":true},"lastError":{"type":"string","description":"Date&Time of the last error occurred.","format":"date-time","nullable":true,"readOnly":true},"lastUpdate":{"type":"string","description":"Date&Time of the last agent update occurred.","format":"date-time","nullable":true,"readOnly":true},"lastStatus":{"type":"string","description":"Last known Agent status.","nullable":true,"readOnly":true}},"additionalProperties":false}}}}
```

## The DtoApiKeyCreate object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoApiKeyCreate":{"required":["EnvironmentId"],"type":"object","properties":{"name":{"type":"string","description":"Name of the API key","nullable":true},"environmentId":{"type":"integer","description":"Identifier of the Environment of the API key","format":"int64"}},"additionalProperties":false}}}}
```

## The DtoApiKeyGet object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoApiKeyGet":{"required":["Environment","Id","Modified","Modifier","Value"],"type":"object","properties":{"name":{"type":"string","description":"Name of the API key","nullable":true},"id":{"type":"integer","description":"Unique identifier for the API key","format":"int64"},"value":{"type":"string","description":"Value of the API key","format":"uuid"},"modified":{"type":"string","description":"The date and time when the API key was last modified","format":"date-time"},"modifier":{"type":"string","description":"The user who last modified the API key","nullable":true},"environment":{"$ref":"#/components/schemas/DtoEnvironmentBase"}},"additionalProperties":false},"DtoEnvironmentBase":{"required":["DisplayName","Id"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Environment","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Environment","readOnly":true}},"additionalProperties":false}}}}
```

## The DtoApiKeyGetResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoApiKeyGetResponse":{"required":["Data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/DtoApiKeyGet"}},"additionalProperties":false},"DtoApiKeyGet":{"required":["Environment","Id","Modified","Modifier","Value"],"type":"object","properties":{"name":{"type":"string","description":"Name of the API key","nullable":true},"id":{"type":"integer","description":"Unique identifier for the API key","format":"int64"},"value":{"type":"string","description":"Value of the API key","format":"uuid"},"modified":{"type":"string","description":"The date and time when the API key was last modified","format":"date-time"},"modifier":{"type":"string","description":"The user who last modified the API key","nullable":true},"environment":{"$ref":"#/components/schemas/DtoEnvironmentBase"}},"additionalProperties":false},"DtoEnvironmentBase":{"required":["DisplayName","Id"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Environment","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Environment","readOnly":true}},"additionalProperties":false}}}}
```

## The DtoApiKeyUpdate object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoApiKeyUpdate":{"required":["Name"],"type":"object","properties":{"name":{"type":"string","description":"Name of the API key","nullable":true}},"additionalProperties":false}}}}
```

## The DtoApiSpecification object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoApiSpecification":{"required":["ActiveVersion","Id","Name"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the API specification","format":"int64"},"name":{"type":"string","description":"Name of the API specification"},"activeVersion":{"type":"integer","description":"Currently active version of the API specification","format":"int32"},"description":{"type":"string","description":"Description for the API specification","nullable":true}},"additionalProperties":false}}}}
```

## The DtoApiSpecificationPagedResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoApiSpecificationPagedResponse":{"required":["Data","Paging"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DtoApiSpecification"},"description":"Response data"},"paging":{"$ref":"#/components/schemas/PagingModel"}},"additionalProperties":false},"DtoApiSpecification":{"required":["ActiveVersion","Id","Name"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the API specification","format":"int64"},"name":{"type":"string","description":"Name of the API specification"},"activeVersion":{"type":"integer","description":"Currently active version of the API specification","format":"int32"},"description":{"type":"string","description":"Description for the API specification","nullable":true}},"additionalProperties":false},"PagingModel":{"required":["CurrentPage","FirstPage","LastPage","PageSize","TotalCount"],"type":"object","properties":{"currentPage":{"type":"integer","description":"Current page","format":"int32"},"pageSize":{"type":"integer","description":"Number of entries per page","format":"int32"},"totalCount":{"type":"integer","description":"Total number of entries","format":"int32"},"firstPage":{"type":"string","description":"Url of the first page","format":"uri","nullable":true},"lastPage":{"type":"string","description":"Url of the last page","format":"uri","nullable":true},"nextPage":{"type":"string","description":"Url of the next page","format":"uri","nullable":true},"previousPage":{"type":"string","description":"Url of the previous page","format":"uri","nullable":true}},"additionalProperties":false}}}}
```

## The DtoApiSpecificationResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoApiSpecificationResponse":{"required":["Data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/DtoApiSpecification"}},"additionalProperties":false},"DtoApiSpecification":{"required":["ActiveVersion","Id","Name"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the API specification","format":"int64"},"name":{"type":"string","description":"Name of the API specification"},"activeVersion":{"type":"integer","description":"Currently active version of the API specification","format":"int32"},"description":{"type":"string","description":"Description for the API specification","nullable":true}},"additionalProperties":false}}}}
```

## The DtoChildSchemaCreate object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoChildSchemaCreate":{"required":["Type"],"type":"object","properties":{"name":{"type":"string"},"type":{"$ref":"#/components/schemas/EnvironmentVariableChildType"}},"additionalProperties":false},"EnvironmentVariableChildType":{"enum":["String","Array","Secret","Number","Boolean"],"type":"string"}}}}
```

## The DtoEnvironmentBase object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoEnvironmentBase":{"required":["DisplayName","Id"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Environment","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Environment","readOnly":true}},"additionalProperties":false}}}}
```

## The DtoEnvironmentGet object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoEnvironmentGet":{"required":["AgentGroups","InternalName"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Environment","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Environment","readOnly":true},"agentGroups":{"type":"array","items":{"$ref":"#/components/schemas/DtoAgentGroupGet"},"description":"The Agent Groups that belong to the Environment","readOnly":true},"internalName":{"type":"string","description":"Internal name used by Frends for the Environment","readOnly":true}},"additionalProperties":false},"DtoAgentGroupGet":{"required":["Agents","Environment","InternalName","IsCrossPlatform"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Agent Group","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Agent Group","readOnly":true},"internalName":{"type":"string","description":"Internal name used by Frends for the Agent Group","readOnly":true},"isCrossPlatform":{"type":"boolean","description":"Indicates whether the Agents in the group can be installed on Windows and Linux machines","readOnly":true},"agents":{"type":"array","items":{"type":"string"},"description":"The Agents that belong to the Agent Group","readOnly":true},"environment":{"$ref":"#/components/schemas/DtoEnvironmentBase"},"agentDetails":{"type":"array","items":{"$ref":"#/components/schemas/DtoAgentGet"},"description":"Details about the Agents that belong to the Agent Group","readOnly":true}},"additionalProperties":false},"DtoEnvironmentBase":{"required":["DisplayName","Id"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Environment","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Environment","readOnly":true}},"additionalProperties":false},"DtoAgentGet":{"required":["IsCloudAgent","IsGateway","Name"],"type":"object","properties":{"url":{"type":"string","description":"The hostname or address for the agent. Can either be full URL https://example.org:1234 or hostname subdomain.example.org","readOnly":true},"httpPorts":{"type":"array","items":{"type":"string"},"description":"List of http ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored.","readOnly":true},"httpsPorts":{"type":"array","items":{"type":"string"},"description":"List of https ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored.","readOnly":true},"id":{"type":"integer","description":"Agent Identifier","format":"int64"},"name":{"type":"string","description":"Agent name","readOnly":true},"isGateway":{"type":"boolean","description":"If the agent is a Gateway Agent. If true, these Agents are the ones that should primarily be accessible from the internet.","readOnly":true},"isCloudAgent":{"type":"boolean","description":"If the agent is a Cloud Agent. If true, these Agents are managed by Frends.","readOnly":true}},"additionalProperties":false}}}}
```

## The DtoEnvironmentGetIListResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoEnvironmentGetIListResponse":{"required":["Data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DtoEnvironmentGet"},"description":"Response data","nullable":true}},"additionalProperties":false},"DtoEnvironmentGet":{"required":["AgentGroups","InternalName"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Environment","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Environment","readOnly":true},"agentGroups":{"type":"array","items":{"$ref":"#/components/schemas/DtoAgentGroupGet"},"description":"The Agent Groups that belong to the Environment","readOnly":true},"internalName":{"type":"string","description":"Internal name used by Frends for the Environment","readOnly":true}},"additionalProperties":false},"DtoAgentGroupGet":{"required":["Agents","Environment","InternalName","IsCrossPlatform"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Agent Group","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Agent Group","readOnly":true},"internalName":{"type":"string","description":"Internal name used by Frends for the Agent Group","readOnly":true},"isCrossPlatform":{"type":"boolean","description":"Indicates whether the Agents in the group can be installed on Windows and Linux machines","readOnly":true},"agents":{"type":"array","items":{"type":"string"},"description":"The Agents that belong to the Agent Group","readOnly":true},"environment":{"$ref":"#/components/schemas/DtoEnvironmentBase"},"agentDetails":{"type":"array","items":{"$ref":"#/components/schemas/DtoAgentGet"},"description":"Details about the Agents that belong to the Agent Group","readOnly":true}},"additionalProperties":false},"DtoEnvironmentBase":{"required":["DisplayName","Id"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Environment","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Environment","readOnly":true}},"additionalProperties":false},"DtoAgentGet":{"required":["IsCloudAgent","IsGateway","Name"],"type":"object","properties":{"url":{"type":"string","description":"The hostname or address for the agent. Can either be full URL https://example.org:1234 or hostname subdomain.example.org","readOnly":true},"httpPorts":{"type":"array","items":{"type":"string"},"description":"List of http ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored.","readOnly":true},"httpsPorts":{"type":"array","items":{"type":"string"},"description":"List of https ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored.","readOnly":true},"id":{"type":"integer","description":"Agent Identifier","format":"int64"},"name":{"type":"string","description":"Agent name","readOnly":true},"isGateway":{"type":"boolean","description":"If the agent is a Gateway Agent. If true, these Agents are the ones that should primarily be accessible from the internet.","readOnly":true},"isCloudAgent":{"type":"boolean","description":"If the agent is a Cloud Agent. If true, these Agents are managed by Frends.","readOnly":true}},"additionalProperties":false}}}}
```

## The DtoEnvironmentGetResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoEnvironmentGetResponse":{"required":["Data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/DtoEnvironmentGet"}},"additionalProperties":false},"DtoEnvironmentGet":{"required":["AgentGroups","InternalName"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Environment","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Environment","readOnly":true},"agentGroups":{"type":"array","items":{"$ref":"#/components/schemas/DtoAgentGroupGet"},"description":"The Agent Groups that belong to the Environment","readOnly":true},"internalName":{"type":"string","description":"Internal name used by Frends for the Environment","readOnly":true}},"additionalProperties":false},"DtoAgentGroupGet":{"required":["Agents","Environment","InternalName","IsCrossPlatform"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Agent Group","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Agent Group","readOnly":true},"internalName":{"type":"string","description":"Internal name used by Frends for the Agent Group","readOnly":true},"isCrossPlatform":{"type":"boolean","description":"Indicates whether the Agents in the group can be installed on Windows and Linux machines","readOnly":true},"agents":{"type":"array","items":{"type":"string"},"description":"The Agents that belong to the Agent Group","readOnly":true},"environment":{"$ref":"#/components/schemas/DtoEnvironmentBase"},"agentDetails":{"type":"array","items":{"$ref":"#/components/schemas/DtoAgentGet"},"description":"Details about the Agents that belong to the Agent Group","readOnly":true}},"additionalProperties":false},"DtoEnvironmentBase":{"required":["DisplayName","Id"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Environment","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Environment","readOnly":true}},"additionalProperties":false},"DtoAgentGet":{"required":["IsCloudAgent","IsGateway","Name"],"type":"object","properties":{"url":{"type":"string","description":"The hostname or address for the agent. Can either be full URL https://example.org:1234 or hostname subdomain.example.org","readOnly":true},"httpPorts":{"type":"array","items":{"type":"string"},"description":"List of http ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored.","readOnly":true},"httpsPorts":{"type":"array","items":{"type":"string"},"description":"List of https ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored.","readOnly":true},"id":{"type":"integer","description":"Agent Identifier","format":"int64"},"name":{"type":"string","description":"Agent name","readOnly":true},"isGateway":{"type":"boolean","description":"If the agent is a Gateway Agent. If true, these Agents are the ones that should primarily be accessible from the internet.","readOnly":true},"isCloudAgent":{"type":"boolean","description":"If the agent is a Cloud Agent. If true, these Agents are managed by Frends.","readOnly":true}},"additionalProperties":false}}}}
```

## The DtoEnvironmentVariableDescriptionUpdate object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoEnvironmentVariableDescriptionUpdate":{"required":["Description"],"type":"object","properties":{"description":{"minLength":1,"type":"string"}},"additionalProperties":false,"description":"New description."}}}}
```

## The DtoEnvironmentVariableSchemaBase object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoEnvironmentVariableSchemaBase":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/EnvironmentVariableType"},"values":{"type":"array","items":{"$ref":"#/components/schemas/DtoEnvironmentVariableValue"},"nullable":true}},"additionalProperties":false},"EnvironmentVariableType":{"enum":["String","Object","Array","Secret","Number","Boolean"],"type":"string"},"DtoEnvironmentVariableValue":{"type":"object","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}},"modifiedUtc":{"type":"string","format":"date-time"},"modifier":{"type":"string"},"version":{"type":"integer","format":"int32"},"environment":{"$ref":"#/components/schemas/DtoEnvironmentBase"}},"additionalProperties":false},"JToken":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}},"DtoEnvironmentBase":{"required":["DisplayName","Id"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Environment","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Environment","readOnly":true}},"additionalProperties":false}}}}
```

## The DtoEnvironmentVariableSchemaGet object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoEnvironmentVariableSchemaGet":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/EnvironmentVariableType"},"values":{"type":"array","items":{"$ref":"#/components/schemas/DtoEnvironmentVariableValue"},"nullable":true},"description":{},"childSchemas":{"type":"array","items":{"$ref":"#/components/schemas/DtoEnvironmentVariableSchemaBase"}}},"additionalProperties":false},"EnvironmentVariableType":{"enum":["String","Object","Array","Secret","Number","Boolean"],"type":"string"},"DtoEnvironmentVariableValue":{"type":"object","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}},"modifiedUtc":{"type":"string","format":"date-time"},"modifier":{"type":"string"},"version":{"type":"integer","format":"int32"},"environment":{"$ref":"#/components/schemas/DtoEnvironmentBase"}},"additionalProperties":false},"JToken":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}},"DtoEnvironmentBase":{"required":["DisplayName","Id"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Environment","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Environment","readOnly":true}},"additionalProperties":false},"DtoEnvironmentVariableSchemaBase":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/EnvironmentVariableType"},"values":{"type":"array","items":{"$ref":"#/components/schemas/DtoEnvironmentVariableValue"},"nullable":true}},"additionalProperties":false}}}}
```

## The DtoEnvironmentVariableSchemaGetPagedResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoEnvironmentVariableSchemaGetPagedResponse":{"required":["Data","Paging"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DtoEnvironmentVariableSchemaGet"},"description":"Response data"},"paging":{"$ref":"#/components/schemas/PagingModel"}},"additionalProperties":false},"DtoEnvironmentVariableSchemaGet":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/EnvironmentVariableType"},"values":{"type":"array","items":{"$ref":"#/components/schemas/DtoEnvironmentVariableValue"},"nullable":true},"description":{},"childSchemas":{"type":"array","items":{"$ref":"#/components/schemas/DtoEnvironmentVariableSchemaBase"}}},"additionalProperties":false},"EnvironmentVariableType":{"enum":["String","Object","Array","Secret","Number","Boolean"],"type":"string"},"DtoEnvironmentVariableValue":{"type":"object","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}},"modifiedUtc":{"type":"string","format":"date-time"},"modifier":{"type":"string"},"version":{"type":"integer","format":"int32"},"environment":{"$ref":"#/components/schemas/DtoEnvironmentBase"}},"additionalProperties":false},"JToken":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}},"DtoEnvironmentBase":{"required":["DisplayName","Id"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Environment","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Environment","readOnly":true}},"additionalProperties":false},"DtoEnvironmentVariableSchemaBase":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/EnvironmentVariableType"},"values":{"type":"array","items":{"$ref":"#/components/schemas/DtoEnvironmentVariableValue"},"nullable":true}},"additionalProperties":false},"PagingModel":{"required":["CurrentPage","FirstPage","LastPage","PageSize","TotalCount"],"type":"object","properties":{"currentPage":{"type":"integer","description":"Current page","format":"int32"},"pageSize":{"type":"integer","description":"Number of entries per page","format":"int32"},"totalCount":{"type":"integer","description":"Total number of entries","format":"int32"},"firstPage":{"type":"string","description":"Url of the first page","format":"uri","nullable":true},"lastPage":{"type":"string","description":"Url of the last page","format":"uri","nullable":true},"nextPage":{"type":"string","description":"Url of the next page","format":"uri","nullable":true},"previousPage":{"type":"string","description":"Url of the previous page","format":"uri","nullable":true}},"additionalProperties":false}}}}
```

## The DtoEnvironmentVariableSchemaGetResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoEnvironmentVariableSchemaGetResponse":{"required":["Data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/DtoEnvironmentVariableSchemaGet"}},"additionalProperties":false},"DtoEnvironmentVariableSchemaGet":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/EnvironmentVariableType"},"values":{"type":"array","items":{"$ref":"#/components/schemas/DtoEnvironmentVariableValue"},"nullable":true},"description":{},"childSchemas":{"type":"array","items":{"$ref":"#/components/schemas/DtoEnvironmentVariableSchemaBase"}}},"additionalProperties":false},"EnvironmentVariableType":{"enum":["String","Object","Array","Secret","Number","Boolean"],"type":"string"},"DtoEnvironmentVariableValue":{"type":"object","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}},"modifiedUtc":{"type":"string","format":"date-time"},"modifier":{"type":"string"},"version":{"type":"integer","format":"int32"},"environment":{"$ref":"#/components/schemas/DtoEnvironmentBase"}},"additionalProperties":false},"JToken":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}},"DtoEnvironmentBase":{"required":["DisplayName","Id"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Environment","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Environment","readOnly":true}},"additionalProperties":false},"DtoEnvironmentVariableSchemaBase":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/EnvironmentVariableType"},"values":{"type":"array","items":{"$ref":"#/components/schemas/DtoEnvironmentVariableValue"},"nullable":true}},"additionalProperties":false}}}}
```

## The DtoEnvironmentVariableValue object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoEnvironmentVariableValue":{"type":"object","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}},"modifiedUtc":{"type":"string","format":"date-time"},"modifier":{"type":"string"},"version":{"type":"integer","format":"int32"},"environment":{"$ref":"#/components/schemas/DtoEnvironmentBase"}},"additionalProperties":false},"JToken":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}},"DtoEnvironmentBase":{"required":["DisplayName","Id"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Environment","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Environment","readOnly":true}},"additionalProperties":false}}}}
```

## The DtoProcessDeploymentCreate object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoProcessDeploymentCreate":{"required":["ActivateTriggers","AgentGroupId","Processes"],"type":"object","properties":{"agentGroupId":{"type":"integer","format":"int64"},"processes":{"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/ProcessVersionInputModel"}},"activateTriggers":{"type":"boolean","description":"Whether to automatically activate Triggers for Processes on deployment. Default is true."},"deploymentDescription":{"type":"string"}},"additionalProperties":false},"ProcessVersionInputModel":{"type":"object","properties":{"processGuid":{"type":"string","format":"uuid"},"version":{"type":"integer","format":"int32"},"processVariables":{"type":"array","items":{"$ref":"#/components/schemas/ProcessVariable"},"nullable":true}},"additionalProperties":false},"ProcessVariable":{"type":"object","properties":{"name":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"isSecret":{"type":"boolean"},"mode":{"type":"string","nullable":true},"description":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The DtoProcessDeploymentGet object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoProcessDeploymentGet":{"required":["AgentGroup"],"type":"object","properties":{"deploymentId":{"type":"integer","description":"Unique identifier for the deployment.","format":"int64"},"processId":{"type":"integer","description":"Unique identifier for Process version.","format":"int64"},"processName":{"minLength":1,"type":"string","description":"Process name"},"processGuid":{"type":"string","description":"Process unique identifier. This is shared between all versions of the Process.","format":"uuid"},"processVersion":{"minLength":1,"type":"string","description":"Process version in the format X.Y.Z."},"processBuildVersion":{"type":"integer","description":"Process build version. This version is incremented by 1 on every successful Process build.","format":"int32"},"deployedAtUtc":{"type":"string","format":"date-time","nullable":true},"deployedBy":{"type":"string","nullable":true},"description":{"type":"string","description":"Optional description for deployment","nullable":true},"triggersActive":{"type":"boolean","description":"Are Process Triggers active"},"agentGroup":{"$ref":"#/components/schemas/DtoAgentGroupBase"}},"additionalProperties":false},"DtoAgentGroupBase":{"required":["DisplayName","Id"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Agent Group","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Agent Group","readOnly":true}},"additionalProperties":false}}}}
```

## The DtoProcessDeploymentGetListResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoProcessDeploymentGetListResponse":{"required":["Data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DtoProcessDeploymentGet"},"description":"Response data","nullable":true}},"additionalProperties":false},"DtoProcessDeploymentGet":{"required":["AgentGroup"],"type":"object","properties":{"deploymentId":{"type":"integer","description":"Unique identifier for the deployment.","format":"int64"},"processId":{"type":"integer","description":"Unique identifier for Process version.","format":"int64"},"processName":{"minLength":1,"type":"string","description":"Process name"},"processGuid":{"type":"string","description":"Process unique identifier. This is shared between all versions of the Process.","format":"uuid"},"processVersion":{"minLength":1,"type":"string","description":"Process version in the format X.Y.Z."},"processBuildVersion":{"type":"integer","description":"Process build version. This version is incremented by 1 on every successful Process build.","format":"int32"},"deployedAtUtc":{"type":"string","format":"date-time","nullable":true},"deployedBy":{"type":"string","nullable":true},"description":{"type":"string","description":"Optional description for deployment","nullable":true},"triggersActive":{"type":"boolean","description":"Are Process Triggers active"},"agentGroup":{"$ref":"#/components/schemas/DtoAgentGroupBase"}},"additionalProperties":false},"DtoAgentGroupBase":{"required":["DisplayName","Id"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Agent Group","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Agent Group","readOnly":true}},"additionalProperties":false}}}}
```

## The DtoProcessDeploymentGetPagedResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoProcessDeploymentGetPagedResponse":{"required":["Data","Paging"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DtoProcessDeploymentGet"},"description":"Response data"},"paging":{"$ref":"#/components/schemas/PagingModel"}},"additionalProperties":false},"DtoProcessDeploymentGet":{"required":["AgentGroup"],"type":"object","properties":{"deploymentId":{"type":"integer","description":"Unique identifier for the deployment.","format":"int64"},"processId":{"type":"integer","description":"Unique identifier for Process version.","format":"int64"},"processName":{"minLength":1,"type":"string","description":"Process name"},"processGuid":{"type":"string","description":"Process unique identifier. This is shared between all versions of the Process.","format":"uuid"},"processVersion":{"minLength":1,"type":"string","description":"Process version in the format X.Y.Z."},"processBuildVersion":{"type":"integer","description":"Process build version. This version is incremented by 1 on every successful Process build.","format":"int32"},"deployedAtUtc":{"type":"string","format":"date-time","nullable":true},"deployedBy":{"type":"string","nullable":true},"description":{"type":"string","description":"Optional description for deployment","nullable":true},"triggersActive":{"type":"boolean","description":"Are Process Triggers active"},"agentGroup":{"$ref":"#/components/schemas/DtoAgentGroupBase"}},"additionalProperties":false},"DtoAgentGroupBase":{"required":["DisplayName","Id"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Agent Group","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Agent Group","readOnly":true}},"additionalProperties":false},"PagingModel":{"required":["CurrentPage","FirstPage","LastPage","PageSize","TotalCount"],"type":"object","properties":{"currentPage":{"type":"integer","description":"Current page","format":"int32"},"pageSize":{"type":"integer","description":"Number of entries per page","format":"int32"},"totalCount":{"type":"integer","description":"Total number of entries","format":"int32"},"firstPage":{"type":"string","description":"Url of the first page","format":"uri","nullable":true},"lastPage":{"type":"string","description":"Url of the last page","format":"uri","nullable":true},"nextPage":{"type":"string","description":"Url of the next page","format":"uri","nullable":true},"previousPage":{"type":"string","description":"Url of the previous page","format":"uri","nullable":true}},"additionalProperties":false}}}}
```

## The DtoProcessDeploymentGetResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoProcessDeploymentGetResponse":{"required":["Data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/DtoProcessDeploymentGet"}},"additionalProperties":false},"DtoProcessDeploymentGet":{"required":["AgentGroup"],"type":"object","properties":{"deploymentId":{"type":"integer","description":"Unique identifier for the deployment.","format":"int64"},"processId":{"type":"integer","description":"Unique identifier for Process version.","format":"int64"},"processName":{"minLength":1,"type":"string","description":"Process name"},"processGuid":{"type":"string","description":"Process unique identifier. This is shared between all versions of the Process.","format":"uuid"},"processVersion":{"minLength":1,"type":"string","description":"Process version in the format X.Y.Z."},"processBuildVersion":{"type":"integer","description":"Process build version. This version is incremented by 1 on every successful Process build.","format":"int32"},"deployedAtUtc":{"type":"string","format":"date-time","nullable":true},"deployedBy":{"type":"string","nullable":true},"description":{"type":"string","description":"Optional description for deployment","nullable":true},"triggersActive":{"type":"boolean","description":"Are Process Triggers active"},"agentGroup":{"$ref":"#/components/schemas/DtoAgentGroupBase"}},"additionalProperties":false},"DtoAgentGroupBase":{"required":["DisplayName","Id"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the Agent Group","format":"int64","readOnly":true},"displayName":{"type":"string","description":"Display name for the Agent Group","readOnly":true}},"additionalProperties":false}}}}
```

## The DtoProcessGet object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoProcessGet":{"required":["name"],"type":"object","properties":{"isDeleted":{"type":"boolean"},"version":{"type":"integer","format":"int32"},"uniqueIdentifier":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int64"},"name":{"minLength":1,"type":"string"},"modified":{"type":"string","format":"date-time"},"modifier":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"isNotLatestVersion":{"type":"boolean"},"changeDescription":{"type":"string","nullable":true},"bpmn":{"type":"string"},"elementParameters":{"type":"array","items":{"$ref":"#/components/schemas/ElementParameters"}},"manualTrigger":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}},"obsoleteTasks":{"type":"array","items":{"$ref":"#/components/schemas/TaskSelectionData"}},"draftId":{"type":"integer","format":"int64","nullable":true},"idOfBaseProcessForDraft":{"type":"integer","format":"int64","nullable":true},"isDraft":{"type":"boolean"},"isSubprocess":{"type":"boolean"},"graphData":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JToken"},"nullable":true},"triggerData":{"type":"array","items":{"$ref":"#/components/schemas/JToken"},"nullable":true},"majorVersion":{"type":"integer","format":"int32"},"minorVersion":{"type":"integer","format":"int32"},"isMigration":{"type":"boolean"},"activateIfNew":{"type":"boolean"},"frendsVersion":{"type":"string","nullable":true},"ignoreDependencyConflicts":{"type":"boolean","nullable":true},"documentationMarkdown":{"type":"string","nullable":true},"targetFramework":{"type":"string"},"apiSpecId":{"type":"integer","format":"int64","nullable":true},"isForMonitoringRule":{"type":"boolean"},"validationOnly":{"type":"boolean"},"cancellationDisabled":{"type":"boolean"},"processVariables":{"type":"array","items":{"$ref":"#/components/schemas/ProcessVariable"},"nullable":true},"processTemplate":{"$ref":"#/components/schemas/ProcessTemplateBase"},"processTemplateDeviated":{"type":"string","format":"date-time","nullable":true},"nextProcessTemplate":{"$ref":"#/components/schemas/ProcessTemplateBase"},"performAdditionalSyntaxValidation":{"type":"boolean"}},"additionalProperties":false},"ElementParameters":{"type":"object","properties":{"id":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/ElementType"},"parameters":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JToken"},"nullable":true},"selectedTypeId":{"type":"string","nullable":true},"promoteResultAs":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"isDefault":{"type":"boolean","nullable":true},"shouldRetry":{"type":"boolean","nullable":true},"maxRetryCount":{"type":"integer","format":"int32","nullable":true},"shouldNotLogResult":{"type":"boolean","nullable":true},"shouldDispose":{"type":"boolean","nullable":true}},"additionalProperties":false},"ElementType":{"enum":["Start","Task","Decision","SequenceFlow","ConditionBranch","Return","Throw","CallActivity","SubProcess","ParallelForeach","SequentialForeach","While","Expression","SubProcessStartNode","Catch","InclusiveGateway","InclusiveDecisionBranch","IntermediateReturn","GlobalErrorHandler","TestTask","SharedState","Dmn","DataObjectReference","DataStoreReference","NativeAi"],"type":"string"},"JToken":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}},"TaskSelectionData":{"type":"object","properties":{"uri":{"type":"string"},"argumentsJson":{"type":"string","nullable":true},"returnType":{"type":"string","nullable":true},"name":{"type":"string"},"displayName":{"type":"string","nullable":true},"packageName":{"type":"string"},"description":{"type":"string","nullable":true},"isNotLatestVersion":{"type":"boolean"},"isStandard":{"type":"boolean"},"isDotNet":{"type":"boolean"}},"additionalProperties":false},"ProcessVariable":{"type":"object","properties":{"name":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"isSecret":{"type":"boolean"},"mode":{"type":"string","nullable":true},"description":{"type":"string","nullable":true}},"additionalProperties":false},"ProcessTemplateBase":{"required":["bpmn","name"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"minLength":1,"type":"string"},"modifier":{"type":"string","nullable":true},"modified":{"type":"string","format":"date-time"},"majorVersion":{"type":"integer","format":"int32"},"minorVersion":{"type":"integer","format":"int32"},"targetFramework":{"type":"string"},"frendsVersion":{"type":"string"},"isSubprocess":{"type":"boolean"},"staticRequiredEnvironmentVariablesJson":{"type":"string"},"isForMonitoringRule":{"type":"boolean"},"cancellationDisabled":{"type":"boolean"},"description":{"type":"string","nullable":true},"changeDescription":{"type":"string","nullable":true},"bpmn":{"minLength":1,"type":"string"},"elementParameters":{"type":"string","nullable":true},"promotedResultVariablesJson":{"type":"string","nullable":true},"usedSubprocessesJson":{"type":"string","nullable":true},"usedTasksJson":{"type":"string","nullable":true},"triggersJson":{"type":"string","nullable":true},"manualTriggerJson":{"type":"string","nullable":true},"uniqueIdentifier":{"type":"string","format":"uuid"},"isListed":{"type":"boolean"},"version":{"type":"integer","format":"int32"},"isDeleted":{"type":"boolean"},"processVariablesJson":{"type":"string","nullable":true},"processTags":{"type":"string","nullable":true},"templateTags":{"type":"array","items":{"type":"string"}},"getVersion":{"type":"string","readOnly":true}},"additionalProperties":false}}}}
```

## The DtoProcessGetProcessLinkModelResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoProcessGetProcessLinkModelResponse":{"required":["Data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/DtoProcessGet"},"links":{"$ref":"#/components/schemas/ProcessLinkModel"}},"additionalProperties":false},"DtoProcessGet":{"required":["name"],"type":"object","properties":{"isDeleted":{"type":"boolean"},"version":{"type":"integer","format":"int32"},"uniqueIdentifier":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int64"},"name":{"minLength":1,"type":"string"},"modified":{"type":"string","format":"date-time"},"modifier":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"isNotLatestVersion":{"type":"boolean"},"changeDescription":{"type":"string","nullable":true},"bpmn":{"type":"string"},"elementParameters":{"type":"array","items":{"$ref":"#/components/schemas/ElementParameters"}},"manualTrigger":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}},"obsoleteTasks":{"type":"array","items":{"$ref":"#/components/schemas/TaskSelectionData"}},"draftId":{"type":"integer","format":"int64","nullable":true},"idOfBaseProcessForDraft":{"type":"integer","format":"int64","nullable":true},"isDraft":{"type":"boolean"},"isSubprocess":{"type":"boolean"},"graphData":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JToken"},"nullable":true},"triggerData":{"type":"array","items":{"$ref":"#/components/schemas/JToken"},"nullable":true},"majorVersion":{"type":"integer","format":"int32"},"minorVersion":{"type":"integer","format":"int32"},"isMigration":{"type":"boolean"},"activateIfNew":{"type":"boolean"},"frendsVersion":{"type":"string","nullable":true},"ignoreDependencyConflicts":{"type":"boolean","nullable":true},"documentationMarkdown":{"type":"string","nullable":true},"targetFramework":{"type":"string"},"apiSpecId":{"type":"integer","format":"int64","nullable":true},"isForMonitoringRule":{"type":"boolean"},"validationOnly":{"type":"boolean"},"cancellationDisabled":{"type":"boolean"},"processVariables":{"type":"array","items":{"$ref":"#/components/schemas/ProcessVariable"},"nullable":true},"processTemplate":{"$ref":"#/components/schemas/ProcessTemplateBase"},"processTemplateDeviated":{"type":"string","format":"date-time","nullable":true},"nextProcessTemplate":{"$ref":"#/components/schemas/ProcessTemplateBase"},"performAdditionalSyntaxValidation":{"type":"boolean"}},"additionalProperties":false},"ElementParameters":{"type":"object","properties":{"id":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/ElementType"},"parameters":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JToken"},"nullable":true},"selectedTypeId":{"type":"string","nullable":true},"promoteResultAs":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"isDefault":{"type":"boolean","nullable":true},"shouldRetry":{"type":"boolean","nullable":true},"maxRetryCount":{"type":"integer","format":"int32","nullable":true},"shouldNotLogResult":{"type":"boolean","nullable":true},"shouldDispose":{"type":"boolean","nullable":true}},"additionalProperties":false},"ElementType":{"enum":["Start","Task","Decision","SequenceFlow","ConditionBranch","Return","Throw","CallActivity","SubProcess","ParallelForeach","SequentialForeach","While","Expression","SubProcessStartNode","Catch","InclusiveGateway","InclusiveDecisionBranch","IntermediateReturn","GlobalErrorHandler","TestTask","SharedState","Dmn","DataObjectReference","DataStoreReference","NativeAi"],"type":"string"},"JToken":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}},"TaskSelectionData":{"type":"object","properties":{"uri":{"type":"string"},"argumentsJson":{"type":"string","nullable":true},"returnType":{"type":"string","nullable":true},"name":{"type":"string"},"displayName":{"type":"string","nullable":true},"packageName":{"type":"string"},"description":{"type":"string","nullable":true},"isNotLatestVersion":{"type":"boolean"},"isStandard":{"type":"boolean"},"isDotNet":{"type":"boolean"}},"additionalProperties":false},"ProcessVariable":{"type":"object","properties":{"name":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"isSecret":{"type":"boolean"},"mode":{"type":"string","nullable":true},"description":{"type":"string","nullable":true}},"additionalProperties":false},"ProcessTemplateBase":{"required":["bpmn","name"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"minLength":1,"type":"string"},"modifier":{"type":"string","nullable":true},"modified":{"type":"string","format":"date-time"},"majorVersion":{"type":"integer","format":"int32"},"minorVersion":{"type":"integer","format":"int32"},"targetFramework":{"type":"string"},"frendsVersion":{"type":"string"},"isSubprocess":{"type":"boolean"},"staticRequiredEnvironmentVariablesJson":{"type":"string"},"isForMonitoringRule":{"type":"boolean"},"cancellationDisabled":{"type":"boolean"},"description":{"type":"string","nullable":true},"changeDescription":{"type":"string","nullable":true},"bpmn":{"minLength":1,"type":"string"},"elementParameters":{"type":"string","nullable":true},"promotedResultVariablesJson":{"type":"string","nullable":true},"usedSubprocessesJson":{"type":"string","nullable":true},"usedTasksJson":{"type":"string","nullable":true},"triggersJson":{"type":"string","nullable":true},"manualTriggerJson":{"type":"string","nullable":true},"uniqueIdentifier":{"type":"string","format":"uuid"},"isListed":{"type":"boolean"},"version":{"type":"integer","format":"int32"},"isDeleted":{"type":"boolean"},"processVariablesJson":{"type":"string","nullable":true},"processTags":{"type":"string","nullable":true},"templateTags":{"type":"array","items":{"type":"string"}},"getVersion":{"type":"string","readOnly":true}},"additionalProperties":false},"ProcessLinkModel":{"required":["Delete","Deployments"],"type":"object","properties":{"deployments":{"$ref":"#/components/schemas/LinkModel"},"delete":{"$ref":"#/components/schemas/LinkModel"}},"additionalProperties":false},"LinkModel":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"method":{"type":"string"}},"additionalProperties":false}}}}
```

## The DtoProcessInstanceGet object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoProcessInstanceGet":{"required":["Data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProcessInstanceViewModel"},"description":"Response data"},"nextContinuationToken":{"type":"string","description":"ContinuationToken to be used in the next query <b>Warning! If any filters except continuationToken are changed between requests the results will be invalid</b>\r\n            <br>If the token is null there are no more results to fetch with the selected filters</br>","nullable":true},"nextLink":{"$ref":"#/components/schemas/LinkModel"}},"additionalProperties":false},"ProcessInstanceViewModel":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"parentId":{"type":"integer","format":"int64","nullable":true},"processId":{"type":"integer","format":"int32"},"rootProcessId":{"type":"integer","format":"int32","nullable":true},"processVersion":{"type":"integer","format":"int32"},"state":{"$ref":"#/components/schemas/ExecutionState"},"startTimeUtc":{"type":"string","format":"date-time","nullable":true},"endTimeUtc":{"type":"string","format":"date-time","nullable":true},"utcDate":{"type":"string","format":"date-time"},"utcHour":{"type":"integer","format":"int32"},"executionId":{"type":"string","format":"uuid"},"triggerId":{"type":"integer","format":"int32","nullable":true},"agentId":{"type":"integer","format":"int32"},"environmentId":{"type":"integer","format":"int32"},"agentGroupId":{"type":"integer","format":"int32"},"exception":{"type":"string","nullable":true},"userName":{"type":"string","nullable":true},"stepsLoggedToBlobs":{"type":"boolean","nullable":true},"hasLoggedSteps":{"type":"boolean","nullable":true},"acknowledgedUtc":{"type":"string","format":"date-time","nullable":true},"commentJson":{"type":"string","nullable":true},"comment":{"type":"string"},"promotedData":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/ProcessPromotedData"},"nullable":true},"triggerName":{"type":"string","nullable":true},"environmentName":{"type":"string","nullable":true},"agentName":{"type":"string","nullable":true},"processGuid":{"type":"string","format":"uuid"},"parentName":{"type":"string","nullable":true},"triggerRequest":{"$ref":"#/components/schemas/JToken"},"triggerResponses":{"$ref":"#/components/schemas/JToken"},"promotedColumns":{"type":"array","items":{"$ref":"#/components/schemas/PromotedColumn"},"nullable":true}},"additionalProperties":false},"ExecutionState":{"enum":["Ok","Waiting","Launched","Starting","Started","Canceled","CanceledByTerminate","FinishedAsZombie","TerminatedByUser","ActionSkipped","Failed","Exception","Finished"],"type":"string"},"ProcessPromotedData":{"required":["environmentName","promotedValueJson","promotedVariableName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"processExecutionId":{"type":"string","format":"uuid"},"timeStamp":{"type":"string","format":"date-time"},"environmentName":{"type":"string"},"promotedVariableName":{"type":"string"},"promotedValueJson":{"type":"string"}},"additionalProperties":false},"JToken":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}},"PromotedColumn":{"type":"object","properties":{"name":{"type":"string","nullable":true},"value":{"$ref":"#/components/schemas/JToken"}},"additionalProperties":false},"LinkModel":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"method":{"type":"string"}},"additionalProperties":false}}}}
```

## The DtoProcessListGet object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoProcessListGet":{"required":["name"],"type":"object","properties":{"isDeleted":{"type":"boolean"},"version":{"type":"integer","format":"int32"},"uniqueIdentifier":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int64"},"name":{"minLength":1,"type":"string"},"modified":{"type":"string","format":"date-time"},"modifier":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"isNotLatestVersion":{"type":"boolean"},"changeDescription":{"type":"string","nullable":true},"bpmn":{"type":"string"},"elementParameters":{"type":"array","items":{"$ref":"#/components/schemas/ElementParameters"}},"manualTrigger":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}},"obsoleteTasks":{"type":"array","items":{"$ref":"#/components/schemas/TaskSelectionData"}},"draftId":{"type":"integer","format":"int64","nullable":true},"idOfBaseProcessForDraft":{"type":"integer","format":"int64","nullable":true},"isDraft":{"type":"boolean"},"isSubprocess":{"type":"boolean"},"graphData":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JToken"},"nullable":true},"triggerData":{"type":"array","items":{"$ref":"#/components/schemas/JToken"},"nullable":true},"majorVersion":{"type":"integer","format":"int32"},"minorVersion":{"type":"integer","format":"int32"},"isMigration":{"type":"boolean"},"activateIfNew":{"type":"boolean"},"frendsVersion":{"type":"string","nullable":true},"ignoreDependencyConflicts":{"type":"boolean","nullable":true},"documentationMarkdown":{"type":"string","nullable":true},"targetFramework":{"type":"string"},"apiSpecId":{"type":"integer","format":"int64","nullable":true},"isForMonitoringRule":{"type":"boolean"},"validationOnly":{"type":"boolean"},"cancellationDisabled":{"type":"boolean"},"processVariables":{"type":"array","items":{"$ref":"#/components/schemas/ProcessVariable"},"nullable":true},"processTemplate":{"$ref":"#/components/schemas/ProcessTemplateBase"},"processTemplateDeviated":{"type":"string","format":"date-time","nullable":true},"nextProcessTemplate":{"$ref":"#/components/schemas/ProcessTemplateBase"},"performAdditionalSyntaxValidation":{"type":"boolean"},"links":{"$ref":"#/components/schemas/ProcessLinkModel"}},"additionalProperties":false},"ElementParameters":{"type":"object","properties":{"id":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/ElementType"},"parameters":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JToken"},"nullable":true},"selectedTypeId":{"type":"string","nullable":true},"promoteResultAs":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"isDefault":{"type":"boolean","nullable":true},"shouldRetry":{"type":"boolean","nullable":true},"maxRetryCount":{"type":"integer","format":"int32","nullable":true},"shouldNotLogResult":{"type":"boolean","nullable":true},"shouldDispose":{"type":"boolean","nullable":true}},"additionalProperties":false},"ElementType":{"enum":["Start","Task","Decision","SequenceFlow","ConditionBranch","Return","Throw","CallActivity","SubProcess","ParallelForeach","SequentialForeach","While","Expression","SubProcessStartNode","Catch","InclusiveGateway","InclusiveDecisionBranch","IntermediateReturn","GlobalErrorHandler","TestTask","SharedState","Dmn","DataObjectReference","DataStoreReference","NativeAi"],"type":"string"},"JToken":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}},"TaskSelectionData":{"type":"object","properties":{"uri":{"type":"string"},"argumentsJson":{"type":"string","nullable":true},"returnType":{"type":"string","nullable":true},"name":{"type":"string"},"displayName":{"type":"string","nullable":true},"packageName":{"type":"string"},"description":{"type":"string","nullable":true},"isNotLatestVersion":{"type":"boolean"},"isStandard":{"type":"boolean"},"isDotNet":{"type":"boolean"}},"additionalProperties":false},"ProcessVariable":{"type":"object","properties":{"name":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"isSecret":{"type":"boolean"},"mode":{"type":"string","nullable":true},"description":{"type":"string","nullable":true}},"additionalProperties":false},"ProcessTemplateBase":{"required":["bpmn","name"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"minLength":1,"type":"string"},"modifier":{"type":"string","nullable":true},"modified":{"type":"string","format":"date-time"},"majorVersion":{"type":"integer","format":"int32"},"minorVersion":{"type":"integer","format":"int32"},"targetFramework":{"type":"string"},"frendsVersion":{"type":"string"},"isSubprocess":{"type":"boolean"},"staticRequiredEnvironmentVariablesJson":{"type":"string"},"isForMonitoringRule":{"type":"boolean"},"cancellationDisabled":{"type":"boolean"},"description":{"type":"string","nullable":true},"changeDescription":{"type":"string","nullable":true},"bpmn":{"minLength":1,"type":"string"},"elementParameters":{"type":"string","nullable":true},"promotedResultVariablesJson":{"type":"string","nullable":true},"usedSubprocessesJson":{"type":"string","nullable":true},"usedTasksJson":{"type":"string","nullable":true},"triggersJson":{"type":"string","nullable":true},"manualTriggerJson":{"type":"string","nullable":true},"uniqueIdentifier":{"type":"string","format":"uuid"},"isListed":{"type":"boolean"},"version":{"type":"integer","format":"int32"},"isDeleted":{"type":"boolean"},"processVariablesJson":{"type":"string","nullable":true},"processTags":{"type":"string","nullable":true},"templateTags":{"type":"array","items":{"type":"string"}},"getVersion":{"type":"string","readOnly":true}},"additionalProperties":false},"ProcessLinkModel":{"required":["Delete","Deployments"],"type":"object","properties":{"deployments":{"$ref":"#/components/schemas/LinkModel"},"delete":{"$ref":"#/components/schemas/LinkModel"}},"additionalProperties":false},"LinkModel":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"method":{"type":"string"}},"additionalProperties":false}}}}
```

## The DtoProcessListGetPagedResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoProcessListGetPagedResponse":{"required":["Data","Paging"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DtoProcessListGet"},"description":"Response data"},"paging":{"$ref":"#/components/schemas/PagingModel"}},"additionalProperties":false},"DtoProcessListGet":{"required":["name"],"type":"object","properties":{"isDeleted":{"type":"boolean"},"version":{"type":"integer","format":"int32"},"uniqueIdentifier":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int64"},"name":{"minLength":1,"type":"string"},"modified":{"type":"string","format":"date-time"},"modifier":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"isNotLatestVersion":{"type":"boolean"},"changeDescription":{"type":"string","nullable":true},"bpmn":{"type":"string"},"elementParameters":{"type":"array","items":{"$ref":"#/components/schemas/ElementParameters"}},"manualTrigger":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}},"obsoleteTasks":{"type":"array","items":{"$ref":"#/components/schemas/TaskSelectionData"}},"draftId":{"type":"integer","format":"int64","nullable":true},"idOfBaseProcessForDraft":{"type":"integer","format":"int64","nullable":true},"isDraft":{"type":"boolean"},"isSubprocess":{"type":"boolean"},"graphData":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JToken"},"nullable":true},"triggerData":{"type":"array","items":{"$ref":"#/components/schemas/JToken"},"nullable":true},"majorVersion":{"type":"integer","format":"int32"},"minorVersion":{"type":"integer","format":"int32"},"isMigration":{"type":"boolean"},"activateIfNew":{"type":"boolean"},"frendsVersion":{"type":"string","nullable":true},"ignoreDependencyConflicts":{"type":"boolean","nullable":true},"documentationMarkdown":{"type":"string","nullable":true},"targetFramework":{"type":"string"},"apiSpecId":{"type":"integer","format":"int64","nullable":true},"isForMonitoringRule":{"type":"boolean"},"validationOnly":{"type":"boolean"},"cancellationDisabled":{"type":"boolean"},"processVariables":{"type":"array","items":{"$ref":"#/components/schemas/ProcessVariable"},"nullable":true},"processTemplate":{"$ref":"#/components/schemas/ProcessTemplateBase"},"processTemplateDeviated":{"type":"string","format":"date-time","nullable":true},"nextProcessTemplate":{"$ref":"#/components/schemas/ProcessTemplateBase"},"performAdditionalSyntaxValidation":{"type":"boolean"},"links":{"$ref":"#/components/schemas/ProcessLinkModel"}},"additionalProperties":false},"ElementParameters":{"type":"object","properties":{"id":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/ElementType"},"parameters":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JToken"},"nullable":true},"selectedTypeId":{"type":"string","nullable":true},"promoteResultAs":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"isDefault":{"type":"boolean","nullable":true},"shouldRetry":{"type":"boolean","nullable":true},"maxRetryCount":{"type":"integer","format":"int32","nullable":true},"shouldNotLogResult":{"type":"boolean","nullable":true},"shouldDispose":{"type":"boolean","nullable":true}},"additionalProperties":false},"ElementType":{"enum":["Start","Task","Decision","SequenceFlow","ConditionBranch","Return","Throw","CallActivity","SubProcess","ParallelForeach","SequentialForeach","While","Expression","SubProcessStartNode","Catch","InclusiveGateway","InclusiveDecisionBranch","IntermediateReturn","GlobalErrorHandler","TestTask","SharedState","Dmn","DataObjectReference","DataStoreReference","NativeAi"],"type":"string"},"JToken":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}},"TaskSelectionData":{"type":"object","properties":{"uri":{"type":"string"},"argumentsJson":{"type":"string","nullable":true},"returnType":{"type":"string","nullable":true},"name":{"type":"string"},"displayName":{"type":"string","nullable":true},"packageName":{"type":"string"},"description":{"type":"string","nullable":true},"isNotLatestVersion":{"type":"boolean"},"isStandard":{"type":"boolean"},"isDotNet":{"type":"boolean"}},"additionalProperties":false},"ProcessVariable":{"type":"object","properties":{"name":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"isSecret":{"type":"boolean"},"mode":{"type":"string","nullable":true},"description":{"type":"string","nullable":true}},"additionalProperties":false},"ProcessTemplateBase":{"required":["bpmn","name"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"minLength":1,"type":"string"},"modifier":{"type":"string","nullable":true},"modified":{"type":"string","format":"date-time"},"majorVersion":{"type":"integer","format":"int32"},"minorVersion":{"type":"integer","format":"int32"},"targetFramework":{"type":"string"},"frendsVersion":{"type":"string"},"isSubprocess":{"type":"boolean"},"staticRequiredEnvironmentVariablesJson":{"type":"string"},"isForMonitoringRule":{"type":"boolean"},"cancellationDisabled":{"type":"boolean"},"description":{"type":"string","nullable":true},"changeDescription":{"type":"string","nullable":true},"bpmn":{"minLength":1,"type":"string"},"elementParameters":{"type":"string","nullable":true},"promotedResultVariablesJson":{"type":"string","nullable":true},"usedSubprocessesJson":{"type":"string","nullable":true},"usedTasksJson":{"type":"string","nullable":true},"triggersJson":{"type":"string","nullable":true},"manualTriggerJson":{"type":"string","nullable":true},"uniqueIdentifier":{"type":"string","format":"uuid"},"isListed":{"type":"boolean"},"version":{"type":"integer","format":"int32"},"isDeleted":{"type":"boolean"},"processVariablesJson":{"type":"string","nullable":true},"processTags":{"type":"string","nullable":true},"templateTags":{"type":"array","items":{"type":"string"}},"getVersion":{"type":"string","readOnly":true}},"additionalProperties":false},"ProcessLinkModel":{"required":["Delete","Deployments"],"type":"object","properties":{"deployments":{"$ref":"#/components/schemas/LinkModel"},"delete":{"$ref":"#/components/schemas/LinkModel"}},"additionalProperties":false},"LinkModel":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"method":{"type":"string"}},"additionalProperties":false},"PagingModel":{"required":["CurrentPage","FirstPage","LastPage","PageSize","TotalCount"],"type":"object","properties":{"currentPage":{"type":"integer","description":"Current page","format":"int32"},"pageSize":{"type":"integer","description":"Number of entries per page","format":"int32"},"totalCount":{"type":"integer","description":"Total number of entries","format":"int32"},"firstPage":{"type":"string","description":"Url of the first page","format":"uri","nullable":true},"lastPage":{"type":"string","description":"Url of the last page","format":"uri","nullable":true},"nextPage":{"type":"string","description":"Url of the next page","format":"uri","nullable":true},"previousPage":{"type":"string","description":"Url of the previous page","format":"uri","nullable":true}},"additionalProperties":false}}}}
```

## The DtoRootSchemaCreate object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"DtoRootSchemaCreate":{"required":["Name"],"type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}}}
```

## The ElementParameters object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ElementParameters":{"type":"object","properties":{"id":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/ElementType"},"parameters":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JToken"},"nullable":true},"selectedTypeId":{"type":"string","nullable":true},"promoteResultAs":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"isDefault":{"type":"boolean","nullable":true},"shouldRetry":{"type":"boolean","nullable":true},"maxRetryCount":{"type":"integer","format":"int32","nullable":true},"shouldNotLogResult":{"type":"boolean","nullable":true},"shouldDispose":{"type":"boolean","nullable":true}},"additionalProperties":false},"ElementType":{"enum":["Start","Task","Decision","SequenceFlow","ConditionBranch","Return","Throw","CallActivity","SubProcess","ParallelForeach","SequentialForeach","While","Expression","SubProcessStartNode","Catch","InclusiveGateway","InclusiveDecisionBranch","IntermediateReturn","GlobalErrorHandler","TestTask","SharedState","Dmn","DataObjectReference","DataStoreReference","NativeAi"],"type":"string"},"JToken":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}}}}}
```

## The ElementType object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ElementType":{"enum":["Start","Task","Decision","SequenceFlow","ConditionBranch","Return","Throw","CallActivity","SubProcess","ParallelForeach","SequentialForeach","While","Expression","SubProcessStartNode","Catch","InclusiveGateway","InclusiveDecisionBranch","IntermediateReturn","GlobalErrorHandler","TestTask","SharedState","Dmn","DataObjectReference","DataStoreReference","NativeAi"],"type":"string"}}}}
```

## The EnvironmentVariableChildType object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"EnvironmentVariableChildType":{"enum":["String","Array","Secret","Number","Boolean"],"type":"string"}}}}
```

## The EnvironmentVariableType object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"EnvironmentVariableType":{"enum":["String","Object","Array","Secret","Number","Boolean"],"type":"string"}}}}
```

## The ExecutionState object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ExecutionState":{"enum":["Ok","Waiting","Launched","Starting","Started","Canceled","CanceledByTerminate","FinishedAsZombie","TerminatedByUser","ActionSkipped","Failed","Exception","Finished"],"type":"string"}}}}
```

## The FilterMode object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"FilterMode":{"enum":["Or","And"],"type":"string"}}}}
```

## The GuidStringListDictionaryResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"GuidStringListDictionaryResponse":{"required":["Data"],"type":"object","properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Response data","nullable":true}},"additionalProperties":false}}}}
```

## The IdentityRuleMatchType object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"],"type":"string"}}}}
```

## The ImportResult object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ImportResult":{"required":["name","resourceLocation"],"type":"object","properties":{"name":{"type":"string"},"elementIdentifier":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int64"},"resourceLocation":{"type":"string","format":"uri"},"version":{"type":"integer","format":"int32"}},"additionalProperties":false}}}}
```

## The ImportResultResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ImportResultResponse":{"required":["Data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImportResult"}},"additionalProperties":false},"ImportResult":{"required":["name","resourceLocation"],"type":"object","properties":{"name":{"type":"string"},"elementIdentifier":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int64"},"resourceLocation":{"type":"string","format":"uri"},"version":{"type":"integer","format":"int32"}},"additionalProperties":false}}}}
```

## The Int32Response object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"Int32Response":{"required":["Data"],"type":"object","properties":{"data":{"type":"integer","description":"Response data","format":"int32"}},"additionalProperties":false}}}}
```

## The Int64ProcessVariableListDictionaryResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"Int64ProcessVariableListDictionaryResponse":{"required":["Data"],"type":"object","properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/ProcessVariable"}},"description":"Response data","nullable":true}},"additionalProperties":false},"ProcessVariable":{"type":"object","properties":{"name":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"isSecret":{"type":"boolean"},"mode":{"type":"string","nullable":true},"description":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The Int64Response object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"Int64Response":{"required":["Data"],"type":"object","properties":{"data":{"type":"integer","description":"Response data","format":"int64"}},"additionalProperties":false}}}}
```

## The IpLoggingType object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"IpLoggingType":{"enum":["ClientIP","ClientIPXForwardedForFirst","ClientIPXForwardedForAll","Disable"],"type":"string"}}}}
```

## The JToken object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"JToken":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}}}}}
```

## The LinkModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"LinkModel":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"method":{"type":"string"}},"additionalProperties":false}}}}
```

## The ModifyApplicationModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ModifyApplicationModel":{"required":["CustomTokenClaims","DefaultTokenLifetimeDays","Name"],"type":"object","properties":{"name":{"type":"string","description":"Name of the application"},"description":{"type":"string","description":"Description of the application","nullable":true},"defaultTokenLifetimeDays":{"maximum":730,"minimum":1,"type":"integer","description":"Default token lifetime in days","format":"int32"},"customTokenClaims":{"type":"object","description":"Custom token claims"},"tags":{"type":"array","items":{"type":"string"},"description":"Tags for the application"}},"additionalProperties":false}}}}
```

## The PagingModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"PagingModel":{"required":["CurrentPage","FirstPage","LastPage","PageSize","TotalCount"],"type":"object","properties":{"currentPage":{"type":"integer","description":"Current page","format":"int32"},"pageSize":{"type":"integer","description":"Number of entries per page","format":"int32"},"totalCount":{"type":"integer","description":"Total number of entries","format":"int32"},"firstPage":{"type":"string","description":"Url of the first page","format":"uri","nullable":true},"lastPage":{"type":"string","description":"Url of the last page","format":"uri","nullable":true},"nextPage":{"type":"string","description":"Url of the next page","format":"uri","nullable":true},"previousPage":{"type":"string","description":"Url of the previous page","format":"uri","nullable":true}},"additionalProperties":false}}}}
```

## The ParameterLocation object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ParameterLocation":{"enum":["Query","Header","Path","Cookie"],"type":"string"}}}}
```

## The PolicyEndpointMethod object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"PolicyEndpointMethod":{"enum":["All","Get","Post","Put","Head","Delete","Patch","Options","Connect","Trace"],"type":"string"}}}}
```

## The PrivateApplicationTokenCreateModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"PrivateApplicationTokenCreateModel":{"required":["Name"],"type":"object","properties":{"name":{"type":"string","description":"Name of the token"},"tokenLifetimeDays":{"type":"integer","description":"Token lifetime in days","format":"int32","nullable":true},"tokenClaims":{"type":"object","description":"Token claims"}},"additionalProperties":false}}}}
```

## The PrivateApplicationTokenViewModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"PrivateApplicationTokenViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Id of the token","format":"int64"},"name":{"type":"string","description":"Name of the token"},"expiryTimeUtc":{"type":"string","description":"Expiry time of the token","format":"date-time"},"createTimeUtc":{"type":"string","description":"Create time of the token","format":"date-time"},"tokenClaims":{"type":"object","description":"Token claims"},"creator":{"type":"string","description":"Creator of the token"},"revoker":{"type":"string","description":"Revoker of the token","nullable":true},"revokeTimeUtc":{"type":"string","description":"Revoked time of the token","format":"date-time","nullable":true},"revokeReason":{"type":"string","description":"Reason for revoking the token","nullable":true},"fullToken":{"type":"string","description":"Raw token"},"payloadOnly":{"type":"string","description":"Only payload part of the token"}},"additionalProperties":false}}}}
```

## The PrivateApplicationTokenViewModelResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"PrivateApplicationTokenViewModelResponse":{"required":["Data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PrivateApplicationTokenViewModel"}},"additionalProperties":false},"PrivateApplicationTokenViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Id of the token","format":"int64"},"name":{"type":"string","description":"Name of the token"},"expiryTimeUtc":{"type":"string","description":"Expiry time of the token","format":"date-time"},"createTimeUtc":{"type":"string","description":"Create time of the token","format":"date-time"},"tokenClaims":{"type":"object","description":"Token claims"},"creator":{"type":"string","description":"Creator of the token"},"revoker":{"type":"string","description":"Revoker of the token","nullable":true},"revokeTimeUtc":{"type":"string","description":"Revoked time of the token","format":"date-time","nullable":true},"revokeReason":{"type":"string","description":"Reason for revoking the token","nullable":true},"fullToken":{"type":"string","description":"Raw token"},"payloadOnly":{"type":"string","description":"Only payload part of the token"}},"additionalProperties":false}}}}
```

## The PrivateApplicationTokensResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"PrivateApplicationTokensResponse":{"required":["tokens"],"type":"object","properties":{"tokenCount":{"type":"integer","format":"int32"},"tokens":{"type":"array","items":{"$ref":"#/components/schemas/PrivateApplicationTokenViewModel"}}},"additionalProperties":false},"PrivateApplicationTokenViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Id of the token","format":"int64"},"name":{"type":"string","description":"Name of the token"},"expiryTimeUtc":{"type":"string","description":"Expiry time of the token","format":"date-time"},"createTimeUtc":{"type":"string","description":"Create time of the token","format":"date-time"},"tokenClaims":{"type":"object","description":"Token claims"},"creator":{"type":"string","description":"Creator of the token"},"revoker":{"type":"string","description":"Revoker of the token","nullable":true},"revokeTimeUtc":{"type":"string","description":"Revoked time of the token","format":"date-time","nullable":true},"revokeReason":{"type":"string","description":"Reason for revoking the token","nullable":true},"fullToken":{"type":"string","description":"Raw token"},"payloadOnly":{"type":"string","description":"Only payload part of the token"}},"additionalProperties":false}}}}
```

## The PrivateApplicationTokensResponseResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"PrivateApplicationTokensResponseResponse":{"required":["Data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PrivateApplicationTokensResponse"}},"additionalProperties":false},"PrivateApplicationTokensResponse":{"required":["tokens"],"type":"object","properties":{"tokenCount":{"type":"integer","format":"int32"},"tokens":{"type":"array","items":{"$ref":"#/components/schemas/PrivateApplicationTokenViewModel"}}},"additionalProperties":false},"PrivateApplicationTokenViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Id of the token","format":"int64"},"name":{"type":"string","description":"Name of the token"},"expiryTimeUtc":{"type":"string","description":"Expiry time of the token","format":"date-time"},"createTimeUtc":{"type":"string","description":"Create time of the token","format":"date-time"},"tokenClaims":{"type":"object","description":"Token claims"},"creator":{"type":"string","description":"Creator of the token"},"revoker":{"type":"string","description":"Revoker of the token","nullable":true},"revokeTimeUtc":{"type":"string","description":"Revoked time of the token","format":"date-time","nullable":true},"revokeReason":{"type":"string","description":"Reason for revoking the token","nullable":true},"fullToken":{"type":"string","description":"Raw token"},"payloadOnly":{"type":"string","description":"Only payload part of the token"}},"additionalProperties":false}}}}
```

## The PrivateApplicationViewModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"PrivateApplicationViewModel":{"required":["CustomTokenClaims","DefaultTokenLifetimeDays","Name"],"type":"object","properties":{"name":{"type":"string","description":"Name of the application"},"description":{"type":"string","description":"Description of the application","nullable":true},"defaultTokenLifetimeDays":{"maximum":730,"minimum":1,"type":"integer","description":"Default token lifetime in days","format":"int32"},"customTokenClaims":{"type":"object","description":"Custom token claims"},"tags":{"type":"array","items":{"type":"string"},"description":"Tags for the application"},"id":{"type":"integer","description":"Id of the application","format":"int64"},"modifier":{"type":"string","description":"Modifier of the application"},"modifiedUtc":{"type":"string","description":"Last modified date of the application","format":"date-time"},"hasTokens":{"type":"boolean","description":"Indicates if the application contains tokens"},"hasActiveTokens":{"type":"boolean","description":"Indicates if the application contains not revoked tokens"},"nextTokenExpiry":{"type":"string","description":"Next token expiry date","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The PrivateApplicationViewModelListResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"PrivateApplicationViewModelListResponse":{"required":["Data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PrivateApplicationViewModel"},"description":"Response data","nullable":true}},"additionalProperties":false},"PrivateApplicationViewModel":{"required":["CustomTokenClaims","DefaultTokenLifetimeDays","Name"],"type":"object","properties":{"name":{"type":"string","description":"Name of the application"},"description":{"type":"string","description":"Description of the application","nullable":true},"defaultTokenLifetimeDays":{"maximum":730,"minimum":1,"type":"integer","description":"Default token lifetime in days","format":"int32"},"customTokenClaims":{"type":"object","description":"Custom token claims"},"tags":{"type":"array","items":{"type":"string"},"description":"Tags for the application"},"id":{"type":"integer","description":"Id of the application","format":"int64"},"modifier":{"type":"string","description":"Modifier of the application"},"modifiedUtc":{"type":"string","description":"Last modified date of the application","format":"date-time"},"hasTokens":{"type":"boolean","description":"Indicates if the application contains tokens"},"hasActiveTokens":{"type":"boolean","description":"Indicates if the application contains not revoked tokens"},"nextTokenExpiry":{"type":"string","description":"Next token expiry date","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The PrivateApplicationViewModelResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"PrivateApplicationViewModelResponse":{"required":["Data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/PrivateApplicationViewModel"}},"additionalProperties":false},"PrivateApplicationViewModel":{"required":["CustomTokenClaims","DefaultTokenLifetimeDays","Name"],"type":"object","properties":{"name":{"type":"string","description":"Name of the application"},"description":{"type":"string","description":"Description of the application","nullable":true},"defaultTokenLifetimeDays":{"maximum":730,"minimum":1,"type":"integer","description":"Default token lifetime in days","format":"int32"},"customTokenClaims":{"type":"object","description":"Custom token claims"},"tags":{"type":"array","items":{"type":"string"},"description":"Tags for the application"},"id":{"type":"integer","description":"Id of the application","format":"int64"},"modifier":{"type":"string","description":"Modifier of the application"},"modifiedUtc":{"type":"string","description":"Last modified date of the application","format":"date-time"},"hasTokens":{"type":"boolean","description":"Indicates if the application contains tokens"},"hasActiveTokens":{"type":"boolean","description":"Indicates if the application contains not revoked tokens"},"nextTokenExpiry":{"type":"string","description":"Next token expiry date","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The ProblemDetails object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## The ProcessCountsByAgentGroupAndProcessAndDateTime object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ProcessCountsByAgentGroupAndProcessAndDateTime":{"required":["executionCounts"],"type":"object","properties":{"executionCounts":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ProcessInstanceExecutionCounts"}}}}},"additionalProperties":false},"ProcessInstanceExecutionCounts":{"type":"object","properties":{"running":{"type":"integer","format":"int32","nullable":true},"latestRunning":{"type":"string","format":"date-time","nullable":true},"successful":{"type":"integer","format":"int32","nullable":true},"latestSuccessful":{"type":"string","format":"date-time","nullable":true},"failed":{"type":"integer","format":"int32","nullable":true},"latestFailed":{"type":"string","format":"date-time","nullable":true},"erroredNotAcknowledged":{"type":"integer","format":"int32","nullable":true},"latestExecutionState":{"$ref":"#/components/schemas/ExecutionState"}},"additionalProperties":false},"ExecutionState":{"enum":["Ok","Waiting","Launched","Starting","Started","Canceled","CanceledByTerminate","FinishedAsZombie","TerminatedByUser","ActionSkipped","Failed","Exception","Finished"],"type":"string"}}}}
```

## The ProcessCountsByAgentGroupAndProcessAndDateTimeResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ProcessCountsByAgentGroupAndProcessAndDateTimeResponse":{"required":["Data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/ProcessCountsByAgentGroupAndProcessAndDateTime"}},"additionalProperties":false},"ProcessCountsByAgentGroupAndProcessAndDateTime":{"required":["executionCounts"],"type":"object","properties":{"executionCounts":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ProcessInstanceExecutionCounts"}}}}},"additionalProperties":false},"ProcessInstanceExecutionCounts":{"type":"object","properties":{"running":{"type":"integer","format":"int32","nullable":true},"latestRunning":{"type":"string","format":"date-time","nullable":true},"successful":{"type":"integer","format":"int32","nullable":true},"latestSuccessful":{"type":"string","format":"date-time","nullable":true},"failed":{"type":"integer","format":"int32","nullable":true},"latestFailed":{"type":"string","format":"date-time","nullable":true},"erroredNotAcknowledged":{"type":"integer","format":"int32","nullable":true},"latestExecutionState":{"$ref":"#/components/schemas/ExecutionState"}},"additionalProperties":false},"ExecutionState":{"enum":["Ok","Waiting","Launched","Starting","Started","Canceled","CanceledByTerminate","FinishedAsZombie","TerminatedByUser","ActionSkipped","Failed","Exception","Finished"],"type":"string"}}}}
```

## The ProcessDataModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ProcessDataModel":{"required":["name"],"type":"object","properties":{"isDeleted":{"type":"boolean"},"version":{"type":"integer","format":"int32"},"uniqueIdentifier":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int64"},"name":{"minLength":1,"type":"string"},"modified":{"type":"string","format":"date-time"},"modifier":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"isNotLatestVersion":{"type":"boolean"},"changeDescription":{"type":"string","nullable":true},"bpmn":{"type":"string"},"elementParameters":{"type":"array","items":{"$ref":"#/components/schemas/ElementParameters"}},"manualTrigger":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}},"obsoleteTasks":{"type":"array","items":{"$ref":"#/components/schemas/TaskSelectionData"}},"draftId":{"type":"integer","format":"int64","nullable":true},"idOfBaseProcessForDraft":{"type":"integer","format":"int64","nullable":true},"isDraft":{"type":"boolean"},"isSubprocess":{"type":"boolean"},"graphData":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JToken"},"nullable":true},"triggerData":{"type":"array","items":{"$ref":"#/components/schemas/JToken"},"nullable":true},"majorVersion":{"type":"integer","format":"int32"},"minorVersion":{"type":"integer","format":"int32"},"isMigration":{"type":"boolean"},"activateIfNew":{"type":"boolean"},"frendsVersion":{"type":"string","nullable":true},"ignoreDependencyConflicts":{"type":"boolean","nullable":true},"documentationMarkdown":{"type":"string","nullable":true},"targetFramework":{"type":"string"},"apiSpecId":{"type":"integer","format":"int64","nullable":true},"isForMonitoringRule":{"type":"boolean"},"validationOnly":{"type":"boolean"},"cancellationDisabled":{"type":"boolean"},"processVariables":{"type":"array","items":{"$ref":"#/components/schemas/ProcessVariable"},"nullable":true},"processTemplate":{"$ref":"#/components/schemas/ProcessTemplateBase"},"processTemplateDeviated":{"type":"string","format":"date-time","nullable":true},"nextProcessTemplate":{"$ref":"#/components/schemas/ProcessTemplateBase"},"performAdditionalSyntaxValidation":{"type":"boolean"}},"additionalProperties":false},"ElementParameters":{"type":"object","properties":{"id":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/ElementType"},"parameters":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JToken"},"nullable":true},"selectedTypeId":{"type":"string","nullable":true},"promoteResultAs":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"isDefault":{"type":"boolean","nullable":true},"shouldRetry":{"type":"boolean","nullable":true},"maxRetryCount":{"type":"integer","format":"int32","nullable":true},"shouldNotLogResult":{"type":"boolean","nullable":true},"shouldDispose":{"type":"boolean","nullable":true}},"additionalProperties":false},"ElementType":{"enum":["Start","Task","Decision","SequenceFlow","ConditionBranch","Return","Throw","CallActivity","SubProcess","ParallelForeach","SequentialForeach","While","Expression","SubProcessStartNode","Catch","InclusiveGateway","InclusiveDecisionBranch","IntermediateReturn","GlobalErrorHandler","TestTask","SharedState","Dmn","DataObjectReference","DataStoreReference","NativeAi"],"type":"string"},"JToken":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}},"TaskSelectionData":{"type":"object","properties":{"uri":{"type":"string"},"argumentsJson":{"type":"string","nullable":true},"returnType":{"type":"string","nullable":true},"name":{"type":"string"},"displayName":{"type":"string","nullable":true},"packageName":{"type":"string"},"description":{"type":"string","nullable":true},"isNotLatestVersion":{"type":"boolean"},"isStandard":{"type":"boolean"},"isDotNet":{"type":"boolean"}},"additionalProperties":false},"ProcessVariable":{"type":"object","properties":{"name":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"isSecret":{"type":"boolean"},"mode":{"type":"string","nullable":true},"description":{"type":"string","nullable":true}},"additionalProperties":false},"ProcessTemplateBase":{"required":["bpmn","name"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"minLength":1,"type":"string"},"modifier":{"type":"string","nullable":true},"modified":{"type":"string","format":"date-time"},"majorVersion":{"type":"integer","format":"int32"},"minorVersion":{"type":"integer","format":"int32"},"targetFramework":{"type":"string"},"frendsVersion":{"type":"string"},"isSubprocess":{"type":"boolean"},"staticRequiredEnvironmentVariablesJson":{"type":"string"},"isForMonitoringRule":{"type":"boolean"},"cancellationDisabled":{"type":"boolean"},"description":{"type":"string","nullable":true},"changeDescription":{"type":"string","nullable":true},"bpmn":{"minLength":1,"type":"string"},"elementParameters":{"type":"string","nullable":true},"promotedResultVariablesJson":{"type":"string","nullable":true},"usedSubprocessesJson":{"type":"string","nullable":true},"usedTasksJson":{"type":"string","nullable":true},"triggersJson":{"type":"string","nullable":true},"manualTriggerJson":{"type":"string","nullable":true},"uniqueIdentifier":{"type":"string","format":"uuid"},"isListed":{"type":"boolean"},"version":{"type":"integer","format":"int32"},"isDeleted":{"type":"boolean"},"processVariablesJson":{"type":"string","nullable":true},"processTags":{"type":"string","nullable":true},"templateTags":{"type":"array","items":{"type":"string"}},"getVersion":{"type":"string","readOnly":true}},"additionalProperties":false}}}}
```

## The ProcessDataModelResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ProcessDataModelResponse":{"required":["Data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/ProcessDataModel"}},"additionalProperties":false},"ProcessDataModel":{"required":["name"],"type":"object","properties":{"isDeleted":{"type":"boolean"},"version":{"type":"integer","format":"int32"},"uniqueIdentifier":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int64"},"name":{"minLength":1,"type":"string"},"modified":{"type":"string","format":"date-time"},"modifier":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"isNotLatestVersion":{"type":"boolean"},"changeDescription":{"type":"string","nullable":true},"bpmn":{"type":"string"},"elementParameters":{"type":"array","items":{"$ref":"#/components/schemas/ElementParameters"}},"manualTrigger":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}},"obsoleteTasks":{"type":"array","items":{"$ref":"#/components/schemas/TaskSelectionData"}},"draftId":{"type":"integer","format":"int64","nullable":true},"idOfBaseProcessForDraft":{"type":"integer","format":"int64","nullable":true},"isDraft":{"type":"boolean"},"isSubprocess":{"type":"boolean"},"graphData":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JToken"},"nullable":true},"triggerData":{"type":"array","items":{"$ref":"#/components/schemas/JToken"},"nullable":true},"majorVersion":{"type":"integer","format":"int32"},"minorVersion":{"type":"integer","format":"int32"},"isMigration":{"type":"boolean"},"activateIfNew":{"type":"boolean"},"frendsVersion":{"type":"string","nullable":true},"ignoreDependencyConflicts":{"type":"boolean","nullable":true},"documentationMarkdown":{"type":"string","nullable":true},"targetFramework":{"type":"string"},"apiSpecId":{"type":"integer","format":"int64","nullable":true},"isForMonitoringRule":{"type":"boolean"},"validationOnly":{"type":"boolean"},"cancellationDisabled":{"type":"boolean"},"processVariables":{"type":"array","items":{"$ref":"#/components/schemas/ProcessVariable"},"nullable":true},"processTemplate":{"$ref":"#/components/schemas/ProcessTemplateBase"},"processTemplateDeviated":{"type":"string","format":"date-time","nullable":true},"nextProcessTemplate":{"$ref":"#/components/schemas/ProcessTemplateBase"},"performAdditionalSyntaxValidation":{"type":"boolean"}},"additionalProperties":false},"ElementParameters":{"type":"object","properties":{"id":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/ElementType"},"parameters":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JToken"},"nullable":true},"selectedTypeId":{"type":"string","nullable":true},"promoteResultAs":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"isDefault":{"type":"boolean","nullable":true},"shouldRetry":{"type":"boolean","nullable":true},"maxRetryCount":{"type":"integer","format":"int32","nullable":true},"shouldNotLogResult":{"type":"boolean","nullable":true},"shouldDispose":{"type":"boolean","nullable":true}},"additionalProperties":false},"ElementType":{"enum":["Start","Task","Decision","SequenceFlow","ConditionBranch","Return","Throw","CallActivity","SubProcess","ParallelForeach","SequentialForeach","While","Expression","SubProcessStartNode","Catch","InclusiveGateway","InclusiveDecisionBranch","IntermediateReturn","GlobalErrorHandler","TestTask","SharedState","Dmn","DataObjectReference","DataStoreReference","NativeAi"],"type":"string"},"JToken":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}},"TaskSelectionData":{"type":"object","properties":{"uri":{"type":"string"},"argumentsJson":{"type":"string","nullable":true},"returnType":{"type":"string","nullable":true},"name":{"type":"string"},"displayName":{"type":"string","nullable":true},"packageName":{"type":"string"},"description":{"type":"string","nullable":true},"isNotLatestVersion":{"type":"boolean"},"isStandard":{"type":"boolean"},"isDotNet":{"type":"boolean"}},"additionalProperties":false},"ProcessVariable":{"type":"object","properties":{"name":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"isSecret":{"type":"boolean"},"mode":{"type":"string","nullable":true},"description":{"type":"string","nullable":true}},"additionalProperties":false},"ProcessTemplateBase":{"required":["bpmn","name"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"minLength":1,"type":"string"},"modifier":{"type":"string","nullable":true},"modified":{"type":"string","format":"date-time"},"majorVersion":{"type":"integer","format":"int32"},"minorVersion":{"type":"integer","format":"int32"},"targetFramework":{"type":"string"},"frendsVersion":{"type":"string"},"isSubprocess":{"type":"boolean"},"staticRequiredEnvironmentVariablesJson":{"type":"string"},"isForMonitoringRule":{"type":"boolean"},"cancellationDisabled":{"type":"boolean"},"description":{"type":"string","nullable":true},"changeDescription":{"type":"string","nullable":true},"bpmn":{"minLength":1,"type":"string"},"elementParameters":{"type":"string","nullable":true},"promotedResultVariablesJson":{"type":"string","nullable":true},"usedSubprocessesJson":{"type":"string","nullable":true},"usedTasksJson":{"type":"string","nullable":true},"triggersJson":{"type":"string","nullable":true},"manualTriggerJson":{"type":"string","nullable":true},"uniqueIdentifier":{"type":"string","format":"uuid"},"isListed":{"type":"boolean"},"version":{"type":"integer","format":"int32"},"isDeleted":{"type":"boolean"},"processVariablesJson":{"type":"string","nullable":true},"processTags":{"type":"string","nullable":true},"templateTags":{"type":"array","items":{"type":"string"}},"getVersion":{"type":"string","readOnly":true}},"additionalProperties":false}}}}
```

## The ProcessInstanceExecutionCounts object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ProcessInstanceExecutionCounts":{"type":"object","properties":{"running":{"type":"integer","format":"int32","nullable":true},"latestRunning":{"type":"string","format":"date-time","nullable":true},"successful":{"type":"integer","format":"int32","nullable":true},"latestSuccessful":{"type":"string","format":"date-time","nullable":true},"failed":{"type":"integer","format":"int32","nullable":true},"latestFailed":{"type":"string","format":"date-time","nullable":true},"erroredNotAcknowledged":{"type":"integer","format":"int32","nullable":true},"latestExecutionState":{"$ref":"#/components/schemas/ExecutionState"}},"additionalProperties":false},"ExecutionState":{"enum":["Ok","Waiting","Launched","Starting","Started","Canceled","CanceledByTerminate","FinishedAsZombie","TerminatedByUser","ActionSkipped","Failed","Exception","Finished"],"type":"string"}}}}
```

## The ProcessInstanceExecutionDetailsViewModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ProcessInstanceExecutionDetailsViewModel":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true},"parentId":{"type":"integer","format":"int64","nullable":true},"parentName":{"type":"string"},"executionId":{"type":"string","format":"uuid","readOnly":true},"processGuid":{"type":"string","format":"uuid"},"rootProcessGuid":{"type":"string","format":"uuid","nullable":true},"processVersion":{"type":"integer","format":"int32","readOnly":true},"state":{"$ref":"#/components/schemas/ExecutionState"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessInstanceStepReferenceViewModel"},"readOnly":true},"stepDataUri":{"type":"string","nullable":true},"startTimeUtc":{"type":"string","format":"date-time","nullable":true,"readOnly":true},"endTimeUtc":{"type":"string","format":"date-time","nullable":true,"readOnly":true},"duration":{"type":"string","format":"date-span","nullable":true,"readOnly":true},"environment":{"type":"string"},"agentGroup":{"type":"string"},"agent":{"type":"string"},"exception":{"type":"string","nullable":true,"readOnly":true},"userName":{"type":"string"},"triggerName":{"type":"string"},"processParameters":{"$ref":"#/components/schemas/JToken"},"processReturnValues":{"$ref":"#/components/schemas/JToken"},"hasLoggedSteps":{"type":"boolean","nullable":true}},"additionalProperties":false},"ExecutionState":{"enum":["Ok","Waiting","Launched","Starting","Started","Canceled","CanceledByTerminate","FinishedAsZombie","TerminatedByUser","ActionSkipped","Failed","Exception","Finished"],"type":"string"},"ProcessInstanceStepReferenceViewModel":{"required":["loopParameters","stepId"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"state":{"$ref":"#/components/schemas/ExecutionState"},"stepId":{"type":"string"},"loopParameters":{"$ref":"#/components/schemas/JToken"}},"additionalProperties":false},"JToken":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}}}}}
```

## The ProcessInstanceExecutionDetailsViewModelResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ProcessInstanceExecutionDetailsViewModelResponse":{"required":["Data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/ProcessInstanceExecutionDetailsViewModel"}},"additionalProperties":false},"ProcessInstanceExecutionDetailsViewModel":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true},"parentId":{"type":"integer","format":"int64","nullable":true},"parentName":{"type":"string"},"executionId":{"type":"string","format":"uuid","readOnly":true},"processGuid":{"type":"string","format":"uuid"},"rootProcessGuid":{"type":"string","format":"uuid","nullable":true},"processVersion":{"type":"integer","format":"int32","readOnly":true},"state":{"$ref":"#/components/schemas/ExecutionState"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ProcessInstanceStepReferenceViewModel"},"readOnly":true},"stepDataUri":{"type":"string","nullable":true},"startTimeUtc":{"type":"string","format":"date-time","nullable":true,"readOnly":true},"endTimeUtc":{"type":"string","format":"date-time","nullable":true,"readOnly":true},"duration":{"type":"string","format":"date-span","nullable":true,"readOnly":true},"environment":{"type":"string"},"agentGroup":{"type":"string"},"agent":{"type":"string"},"exception":{"type":"string","nullable":true,"readOnly":true},"userName":{"type":"string"},"triggerName":{"type":"string"},"processParameters":{"$ref":"#/components/schemas/JToken"},"processReturnValues":{"$ref":"#/components/schemas/JToken"},"hasLoggedSteps":{"type":"boolean","nullable":true}},"additionalProperties":false},"ExecutionState":{"enum":["Ok","Waiting","Launched","Starting","Started","Canceled","CanceledByTerminate","FinishedAsZombie","TerminatedByUser","ActionSkipped","Failed","Exception","Finished"],"type":"string"},"ProcessInstanceStepReferenceViewModel":{"required":["loopParameters","stepId"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"state":{"$ref":"#/components/schemas/ExecutionState"},"stepId":{"type":"string"},"loopParameters":{"$ref":"#/components/schemas/JToken"}},"additionalProperties":false},"JToken":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}}}}}
```

## The ProcessInstanceFilter object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ProcessInstanceFilter":{"enum":["ShowAll","ShowRunning","ShowFinished","ShowSuccessful","ShowFailed","ShowFailedNotAcknowledged"],"type":"string"}}}}
```

## The ProcessInstanceStepReferenceViewModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ProcessInstanceStepReferenceViewModel":{"required":["loopParameters","stepId"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"state":{"$ref":"#/components/schemas/ExecutionState"},"stepId":{"type":"string"},"loopParameters":{"$ref":"#/components/schemas/JToken"}},"additionalProperties":false},"ExecutionState":{"enum":["Ok","Waiting","Launched","Starting","Started","Canceled","CanceledByTerminate","FinishedAsZombie","TerminatedByUser","ActionSkipped","Failed","Exception","Finished"],"type":"string"},"JToken":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}}}}}
```

## The ProcessInstanceViewModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ProcessInstanceViewModel":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"parentId":{"type":"integer","format":"int64","nullable":true},"processId":{"type":"integer","format":"int32"},"rootProcessId":{"type":"integer","format":"int32","nullable":true},"processVersion":{"type":"integer","format":"int32"},"state":{"$ref":"#/components/schemas/ExecutionState"},"startTimeUtc":{"type":"string","format":"date-time","nullable":true},"endTimeUtc":{"type":"string","format":"date-time","nullable":true},"utcDate":{"type":"string","format":"date-time"},"utcHour":{"type":"integer","format":"int32"},"executionId":{"type":"string","format":"uuid"},"triggerId":{"type":"integer","format":"int32","nullable":true},"agentId":{"type":"integer","format":"int32"},"environmentId":{"type":"integer","format":"int32"},"agentGroupId":{"type":"integer","format":"int32"},"exception":{"type":"string","nullable":true},"userName":{"type":"string","nullable":true},"stepsLoggedToBlobs":{"type":"boolean","nullable":true},"hasLoggedSteps":{"type":"boolean","nullable":true},"acknowledgedUtc":{"type":"string","format":"date-time","nullable":true},"commentJson":{"type":"string","nullable":true},"comment":{"type":"string"},"promotedData":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/ProcessPromotedData"},"nullable":true},"triggerName":{"type":"string","nullable":true},"environmentName":{"type":"string","nullable":true},"agentName":{"type":"string","nullable":true},"processGuid":{"type":"string","format":"uuid"},"parentName":{"type":"string","nullable":true},"triggerRequest":{"$ref":"#/components/schemas/JToken"},"triggerResponses":{"$ref":"#/components/schemas/JToken"},"promotedColumns":{"type":"array","items":{"$ref":"#/components/schemas/PromotedColumn"},"nullable":true}},"additionalProperties":false},"ExecutionState":{"enum":["Ok","Waiting","Launched","Starting","Started","Canceled","CanceledByTerminate","FinishedAsZombie","TerminatedByUser","ActionSkipped","Failed","Exception","Finished"],"type":"string"},"ProcessPromotedData":{"required":["environmentName","promotedValueJson","promotedVariableName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"processExecutionId":{"type":"string","format":"uuid"},"timeStamp":{"type":"string","format":"date-time"},"environmentName":{"type":"string"},"promotedVariableName":{"type":"string"},"promotedValueJson":{"type":"string"}},"additionalProperties":false},"JToken":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}},"PromotedColumn":{"type":"object","properties":{"name":{"type":"string","nullable":true},"value":{"$ref":"#/components/schemas/JToken"}},"additionalProperties":false}}}}
```

## The ProcessLinkModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ProcessLinkModel":{"required":["Delete","Deployments"],"type":"object","properties":{"deployments":{"$ref":"#/components/schemas/LinkModel"},"delete":{"$ref":"#/components/schemas/LinkModel"}},"additionalProperties":false},"LinkModel":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"method":{"type":"string"}},"additionalProperties":false}}}}
```

## The ProcessPromotedData object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ProcessPromotedData":{"required":["environmentName","promotedValueJson","promotedVariableName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"processExecutionId":{"type":"string","format":"uuid"},"timeStamp":{"type":"string","format":"date-time"},"environmentName":{"type":"string"},"promotedVariableName":{"type":"string"},"promotedValueJson":{"type":"string"}},"additionalProperties":false}}}}
```

## The ProcessTemplateBase object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ProcessTemplateBase":{"required":["bpmn","name"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"minLength":1,"type":"string"},"modifier":{"type":"string","nullable":true},"modified":{"type":"string","format":"date-time"},"majorVersion":{"type":"integer","format":"int32"},"minorVersion":{"type":"integer","format":"int32"},"targetFramework":{"type":"string"},"frendsVersion":{"type":"string"},"isSubprocess":{"type":"boolean"},"staticRequiredEnvironmentVariablesJson":{"type":"string"},"isForMonitoringRule":{"type":"boolean"},"cancellationDisabled":{"type":"boolean"},"description":{"type":"string","nullable":true},"changeDescription":{"type":"string","nullable":true},"bpmn":{"minLength":1,"type":"string"},"elementParameters":{"type":"string","nullable":true},"promotedResultVariablesJson":{"type":"string","nullable":true},"usedSubprocessesJson":{"type":"string","nullable":true},"usedTasksJson":{"type":"string","nullable":true},"triggersJson":{"type":"string","nullable":true},"manualTriggerJson":{"type":"string","nullable":true},"uniqueIdentifier":{"type":"string","format":"uuid"},"isListed":{"type":"boolean"},"version":{"type":"integer","format":"int32"},"isDeleted":{"type":"boolean"},"processVariablesJson":{"type":"string","nullable":true},"processTags":{"type":"string","nullable":true},"templateTags":{"type":"array","items":{"type":"string"}},"getVersion":{"type":"string","readOnly":true}},"additionalProperties":false}}}}
```

## The ProcessTemplateBaseResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ProcessTemplateBaseResponse":{"required":["Data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/ProcessTemplateBase"}},"additionalProperties":false},"ProcessTemplateBase":{"required":["bpmn","name"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"minLength":1,"type":"string"},"modifier":{"type":"string","nullable":true},"modified":{"type":"string","format":"date-time"},"majorVersion":{"type":"integer","format":"int32"},"minorVersion":{"type":"integer","format":"int32"},"targetFramework":{"type":"string"},"frendsVersion":{"type":"string"},"isSubprocess":{"type":"boolean"},"staticRequiredEnvironmentVariablesJson":{"type":"string"},"isForMonitoringRule":{"type":"boolean"},"cancellationDisabled":{"type":"boolean"},"description":{"type":"string","nullable":true},"changeDescription":{"type":"string","nullable":true},"bpmn":{"minLength":1,"type":"string"},"elementParameters":{"type":"string","nullable":true},"promotedResultVariablesJson":{"type":"string","nullable":true},"usedSubprocessesJson":{"type":"string","nullable":true},"usedTasksJson":{"type":"string","nullable":true},"triggersJson":{"type":"string","nullable":true},"manualTriggerJson":{"type":"string","nullable":true},"uniqueIdentifier":{"type":"string","format":"uuid"},"isListed":{"type":"boolean"},"version":{"type":"integer","format":"int32"},"isDeleted":{"type":"boolean"},"processVariablesJson":{"type":"string","nullable":true},"processTags":{"type":"string","nullable":true},"templateTags":{"type":"array","items":{"type":"string"}},"getVersion":{"type":"string","readOnly":true}},"additionalProperties":false}}}}
```

## The ProcessTemplateListViewModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ProcessTemplateListViewModel":{"required":["modifier","name"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"modifier":{"type":"string"},"modified":{"type":"string","format":"date-time"},"majorVersion":{"type":"integer","format":"int32"},"minorVersion":{"type":"integer","format":"int32"},"targetFramework":{"type":"string"},"frendsVersion":{"type":"string"},"isSubprocess":{"type":"boolean"},"staticRequiredEnvironmentVariablesJson":{"type":"string"},"isForMonitoringRule":{"type":"boolean"},"description":{"type":"string","nullable":true},"promotedResultVariablesJson":{"type":"string","nullable":true},"usedSubprocessesJson":{"type":"string","nullable":true},"usedTasksJson":{"type":"string","nullable":true},"triggersJson":{"type":"string","nullable":true},"manualTriggerJson":{"type":"string","nullable":true},"isCrossPlatform":{"type":"boolean","readOnly":true},"isDotNet":{"type":"boolean","readOnly":true},"isListed":{"type":"boolean"},"version":{"type":"integer","format":"int32"},"isDeleted":{"type":"boolean"},"processVariablesJson":{"type":"string","nullable":true},"processTags":{"type":"string","nullable":true},"uniqueIdentifier":{"type":"string","format":"uuid"},"templateTags":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false}}}}
```

## The ProcessTemplateListViewModelPagedResponse object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ProcessTemplateListViewModelPagedResponse":{"required":["Data","Paging"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProcessTemplateListViewModel"},"description":"Response data"},"paging":{"$ref":"#/components/schemas/PagingModel"}},"additionalProperties":false},"ProcessTemplateListViewModel":{"required":["modifier","name"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"modifier":{"type":"string"},"modified":{"type":"string","format":"date-time"},"majorVersion":{"type":"integer","format":"int32"},"minorVersion":{"type":"integer","format":"int32"},"targetFramework":{"type":"string"},"frendsVersion":{"type":"string"},"isSubprocess":{"type":"boolean"},"staticRequiredEnvironmentVariablesJson":{"type":"string"},"isForMonitoringRule":{"type":"boolean"},"description":{"type":"string","nullable":true},"promotedResultVariablesJson":{"type":"string","nullable":true},"usedSubprocessesJson":{"type":"string","nullable":true},"usedTasksJson":{"type":"string","nullable":true},"triggersJson":{"type":"string","nullable":true},"manualTriggerJson":{"type":"string","nullable":true},"isCrossPlatform":{"type":"boolean","readOnly":true},"isDotNet":{"type":"boolean","readOnly":true},"isListed":{"type":"boolean"},"version":{"type":"integer","format":"int32"},"isDeleted":{"type":"boolean"},"processVariablesJson":{"type":"string","nullable":true},"processTags":{"type":"string","nullable":true},"uniqueIdentifier":{"type":"string","format":"uuid"},"templateTags":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"PagingModel":{"required":["CurrentPage","FirstPage","LastPage","PageSize","TotalCount"],"type":"object","properties":{"currentPage":{"type":"integer","description":"Current page","format":"int32"},"pageSize":{"type":"integer","description":"Number of entries per page","format":"int32"},"totalCount":{"type":"integer","description":"Total number of entries","format":"int32"},"firstPage":{"type":"string","description":"Url of the first page","format":"uri","nullable":true},"lastPage":{"type":"string","description":"Url of the last page","format":"uri","nullable":true},"nextPage":{"type":"string","description":"Url of the next page","format":"uri","nullable":true},"previousPage":{"type":"string","description":"Url of the previous page","format":"uri","nullable":true}},"additionalProperties":false}}}}
```

## The ProcessTemplateTagRequestModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ProcessTemplateTagRequestModel":{"required":["Overwrite","Tags"],"type":"object","properties":{"templateIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"List of Process template ids"},"tags":{"type":"array","items":{"type":"string"},"description":"Tags to be added to the Process templates"},"overwrite":{"type":"boolean","description":"If true the tags will be overwritten"}},"additionalProperties":false}}}}
```

## The ProcessVariable object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ProcessVariable":{"type":"object","properties":{"name":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"isSecret":{"type":"boolean"},"mode":{"type":"string","nullable":true},"description":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The ProcessVersionInputModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"ProcessVersionInputModel":{"type":"object","properties":{"processGuid":{"type":"string","format":"uuid"},"version":{"type":"integer","format":"int32"},"processVariables":{"type":"array","items":{"$ref":"#/components/schemas/ProcessVariable"},"nullable":true}},"additionalProperties":false},"ProcessVariable":{"type":"object","properties":{"name":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"isSecret":{"type":"boolean"},"mode":{"type":"string","nullable":true},"description":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The PromotedColumn object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"PromotedColumn":{"type":"object","properties":{"name":{"type":"string","nullable":true},"value":{"$ref":"#/components/schemas/JToken"}},"additionalProperties":false},"JToken":{"type":"array","items":{"$ref":"#/components/schemas/JToken"}}}}}
```

## The PublishApiRequest object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"PublishApiRequest":{"type":"object","properties":{"changeDescription":{"type":"string","description":"Description of the changes made","nullable":true}},"additionalProperties":false}}}}
```

## The TagElementType object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"TagElementType":{"enum":["Process","ProcessTemplate","PrivateApplication","ApiPolicy"],"type":"string"}}}}
```

## The TagRequestModel object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"TagRequestModel":{"type":"object","properties":{"elementType":{"$ref":"#/components/schemas/TagElementType"},"tags":{"type":"array","items":{"type":"string"},"description":"List of tags"},"elementGuids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"List of element unique identifiers"}},"additionalProperties":false},"TagElementType":{"enum":["Process","ProcessTemplate","PrivateApplication","ApiPolicy"],"type":"string"}}}}
```

## The TaskSelectionData object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"TaskSelectionData":{"type":"object","properties":{"uri":{"type":"string"},"argumentsJson":{"type":"string","nullable":true},"returnType":{"type":"string","nullable":true},"name":{"type":"string"},"displayName":{"type":"string","nullable":true},"packageName":{"type":"string"},"description":{"type":"string","nullable":true},"isNotLatestVersion":{"type":"boolean"},"isStandard":{"type":"boolean"},"isDotNet":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The TemplateType object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"TemplateType":{"enum":["All","ProcessTemplatesOnly","SubprocessTemplatesOnly"],"type":"string"}}}}
```

## The UpdateProcessesBasedOnTemplateRequestBody object

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"components":{"schemas":{"UpdateProcessesBasedOnTemplateRequestBody":{"type":"object","properties":{"processIds":{"type":"array","items":{"type":"integer","format":"int64"},"nullable":true}},"additionalProperties":false}}}}
```