GET v1/capps/get/{id}

get capp for given id

Request Information

URI Parameters

Name	Description	Type	Additional information
id		string	Required

Body Parameters

None.

Response Information

Resource Description

ConfidenceApps.Interfaces.CApps.ICApp

Name	Description	Type	Additional information
AppVersion	The version number of the CApp allows dynamic changes in the AppDesigner, while each current Version can be used on the devices.	string	None.
AllowSendWithInvalidData	Indicates if a summary should be visible before the result can be send.	boolean	None.
CanceledName	The evaluated CancelName for naming an open CApp-Process.	string	None.
Icon	The custom icon of a CApp. Defined by AppDesigner.	Collection of byte	None.
IsChanged	Indicates if at least one property has changed since the last reset (except Id). Can be reseted by set to false.	boolean	None.
Layout	The layout and design property changes the lookup of the CApp.	ConfidenceApps.Interfaces.CApps.ILayout	None.
LogTimestamp	Indicates if inputs should create a timestamp of the input time.	boolean	None.
Name	The name of the CApp.	string	None.
Pages	The list of pages an App consists of.	Collection of ConfidenceApps.Interfaces.CApps.IPage	None.
Resources	The List of all appended resources.	Collection of ConfidenceApps.Interfaces.CApps.IResource	None.
SchemaColorId	The identifier of a color schema.	globally unique identifier	None.
ShowSummary	Indicates if a summary should be visible before the result can be send.	boolean	None.
Status	The state of the stored App.	ConfidenceApps.Types.State	None.
TargetPageIdAfterSendResult	The guid of the target page of the current workflow app which will be shown after the result was send.	globally unique identifier	None.
TaskDescription	The specification pattern for naming an open CApp-Process.	string	None.
ValidUntil	An optional end date time of the app´s validation.	date	None.
XmlVersion	The version number of the model schema.	string	None.
AllowTaskReAssign	Defines if it is allowed to reassign tasks to another user.	boolean	None.
IsTaskOnly	Defines if the app can only be started by a task	boolean	None.
ReportTemplateId	Defines if the app has a global report template id. this template is used for all pdf reports.	globally unique identifier	None.
ServerTimeStamp	The last modification on the cloud portal server	date	None.
CanSaveOnLeavingApp	Specifies that on leaving capp the result can be saved (Default: true)	boolean	None.
UseButtonNavigationOnLargeScreen	Specifies that on large screens the next/previos buttons are used for navigation	boolean	None.
InfoDescription	property to hold the info description of the app	string	None.
InfoVersion	property to hold the info version of the app	string	None.

Response Formats

application/json, text/json

Sample:

{
  "appVersion": "1.0",
  "allowSendWithInvalidData": false,
  "createdAt": "2024-05-07T22:25:04",
  "id": "6e556d46-6711-4102-a4e0-eb8c62621a03",
  "layout": {
    "predefinedDesign": "Profi",
    "errorColor": "#FFFF0000",
    "navigationFontColor": "#FF000000",
    "schemaColor1": "#FF008000",
    "schemaColor2": "#FFFFFF00",
    "schemaColor3": "#FFFFA500",
    "schemaFontColor1": "#FF000000",
    "schemaFontColor2": "#FFFFFFFF",
    "schemaFontColor3": "#FFFFE4C4",
    "standardColorVariation": 0.0,
    "validationColorFail": "#FFFF0000",
    "validationColorSuccess": "#FF008000",
    "createdAt": "0001-01-01T00:00:00",
    "modifiedAt": "0001-01-01T00:00:00",
    "referenceId": "00000000-0000-0000-0000-000000000000"
  },
  "logTimestamp": false,
  "modifiedAt": "2024-05-07T22:25:04",
  "name": "Sample App - Interface",
  "resources": [],
  "showSummary": false,
  "status": "New",
  "xmlVersion": "2.0",
  "isChanged": false,
  "referenceId": "00000000-0000-0000-0000-000000000000",
  "allowTaskReAssign": false,
  "isTaskOnly": false,
  "canSaveOnLeavingApp": true,
  "useButtonNavigationOnLargeScreen": false,
  "pages": [
    {
      "content": [
        {
          "isInputField": false,
          "isLimitedInput": false,
          "type": "None",
          "label": "Sample Group 1",
          "required": false,
          "showInRepeatOverview": false,
          "values": [],
          "hasContent": false,
          "logTimestamp": false,
          "maximum": 0,
          "minimum": 0,
          "maximumDouble": 0.0,
          "minimumDouble": 0.0,
          "mode": "None",
          "formControls": [
            {
              "isInputField": false,
              "isLimitedInput": false,
              "type": "None",
              "label": "Sample FormControl 1",
              "required": false,
              "showInRepeatOverview": false,
              "values": [],
              "hasContent": false,
              "inputFieldName": "formcontrol1",
              "logTimestamp": false,
              "maximum": 0,
              "minimum": 0,
              "maximumDouble": 0.0,
              "minimumDouble": 0.0,
              "mode": "None",
              "formControls": [],
              "isEditable": false,
              "isHorizontal": false,
              "isButton": false,
              "cleared": false,
              "textMode": "IsSingleLine",
              "createdAt": "0001-01-01T00:00:00",
              "modifiedAt": "0001-01-01T00:00:00",
              "referenceId": "00000000-0000-0000-0000-000000000000",
              "photoResolution": "small",
              "color": "#FFFFBC00",
              "canLoadFromLibrary": true,
              "canEditPhoto": false,
              "isReadOnly": false,
              "height": 0,
              "visibilityCondition": {
                "isVisible": false,
                "link": "AND",
                "conditions": [],
                "createdAt": "0001-01-01T00:00:00",
                "modifiedAt": "0001-01-01T00:00:00",
                "referenceId": "00000000-0000-0000-0000-000000000000",
                "isEnabled": true,
                "isUIOnly": false
              },
              "showInReport": true,
              "reportStartAtNewPage": false,
              "formulaMode": "Numbers",
              "saveToAlbum": false,
              "dataBindings": [],
              "reportShowTextAndValue": false,
              "isAutomaticPositionActive": true,
              "canMultiSelect": false,
              "isAutoComplete": false,
              "backColor": ""
            }
          ],
          "isEditable": false,
          "isHorizontal": false,
          "isButton": false,
          "cleared": false,
          "textMode": "IsSingleLine",
          "createdAt": "0001-01-01T00:00:00",
          "modifiedAt": "0001-01-01T00:00:00",
          "referenceId": "00000000-0000-0000-0000-000000000000",
          "photoResolution": "small",
          "color": "#FFFFBC00",
          "canLoadFromLibrary": true,
          "canEditPhoto": false,
          "isReadOnly": false,
          "height": 0,
          "visibilityCondition": {
            "isVisible": false,
            "link": "AND",
            "conditions": [],
            "createdAt": "0001-01-01T00:00:00",
            "modifiedAt": "0001-01-01T00:00:00",
            "referenceId": "00000000-0000-0000-0000-000000000000",
            "isEnabled": true,
            "isUIOnly": false
          },
          "showInReport": true,
          "reportStartAtNewPage": false,
          "formulaMode": "Numbers",
          "saveToAlbum": false,
          "dataBindings": [],
          "reportShowTextAndValue": false,
          "isAutomaticPositionActive": true,
          "canMultiSelect": false,
          "isAutoComplete": false,
          "backColor": ""
        }
      ],
      "title": "Sample Page 1",
      "createdAt": "0001-01-01T00:00:00",
      "modifiedAt": "0001-01-01T00:00:00",
      "referenceId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}