Inphinity Forms (API v2)

Download OpenAPI specification:

Inphinity Forms API

Form General

Query all records

This endpoint is used to query all records stored in the form instance. If the changelog parameter is sent and set to true, deleted records as well as older (changed) values of records will be included in the response.

Status

Stable - with the exception of the metadata field when application/vnd.inphinity-forms+json content type is used.

Authorization

Required permissions: READ

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance

required

string

ID of form instance

query Parameters

changelog	boolean Return full changelog
since	string <date-time> ISO 8601 formatted timestamp; only records newer than this timestamp will be returned

Responses

Response samples

200

Content type

text/xml

No sample

Upsert records

This endpoint is used to insert new records or update existing records.

Status

Stable - with the exception of the metadata field when application/vnd.inphinity-forms+json content type is used.

Authorization

Required permissions: WRITE

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance

required

string

ID of form instance

header Parameters

Prefer

string

The endpoint respects the return=minimal preference in HTTP Prefer header, as per RFC 7240. The client should specify this preference whenever the full response is not needed, as that may result in a performance optimization when inserting the records into the instance storage.

Request Body schema:
application/json
required

Array

$key	string Record key; when omitted or null, a new key will be generated on insert; when present, must be a non-empty string
$changedAt	string <date-time> ISO 8601 formatted timestamp of when the record was modified
$changedBy	string
$changedByName	string
$deleted	boolean
$isNew	boolean
property name* additional property	any

Responses

Request samples

Payload

Content type

application/json

[{"$key": "582e0548-4e62-4bf3-9b14-855662c0e47e",
"region": "EMEA",
"billings": "1000000"
},
{"region": "APAC",
"billings": "2000000"
}
]

Response samples

201

Content type

application/json

[{"$key": "582e0548-4e62-4bf3-9b14-855662c0e47e",
"$changedAt": "2023-09-30T09:20:10Z",
"$changedBy": "thisuser",
"$changedByName": "This User",
"region": "EMEA",
"billings": "1000000"
},
{"$key": "46116a62-b6f7-4939-8f78-d142b8f0657a",
"$changedAt": "2023-09-30T09:20:10Z",
"$changedBy": "thisuser",
"$changedByName": "This User",
"$isNew": true,
"region": "APAC",
"billings": "2000000"
}
]

Batch-upsert records

This endpoint is used to upsert (update or insert) multiple records with the same change. Multiple different changes can be submitted.

Status

Stable.

Authorization

Required permissions: WRITE

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance

required

string

ID of form instance

Request Body schema:
application/json
required

Array

keys required	Array of strings
modification required	object

Responses

Request samples

Payload

Content type

application/json

[{"keys": ["582e0548-4e62-4bf3-9b14-855662c0e47e",
"5e499891-a3cf-4f7e-ac9f-bd05d019320e",
""
],
"modification": {"billings": "1000000"
}
}
]

Delete all records

This endpoint is used to completely remove all records stored in the forms instance, including the changelog.

Status

Stable - with the exception of the metadata field when application/vnd.inphinity-forms+json content type is used.

Authorization

Required permissions: PURGE

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance

required

string

ID of form instance

Responses

Delete a single record

This endpoint is used to delete a single record. If the underlying storage supports it, the record is only marked as deleted.

Status

Stable.

Authorization

Required permissions: WRITE

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance required	string ID of form instance
key required	string ID of record to delete

Responses

Query records by keys

This endpoint is used to query records stored in the form instance based on a list of record keys provided in the request. If the changelog parameter is sent and set to true, deleted records as well as previous values of records will be included in the response.

Status

Stable - with the exception of the metadata field when application/vnd.inphinity-forms+json content type is used.

Authorization

Required permissions: READ

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance

required

string

ID of form instance

Request Body schema:
application/json
required

Form query parameters

keys

required

Array of strings

List of record keys to query

Responses

Request samples

Payload

Content type

application/json

{"keys": ["582e0548-4e62-4bf3-9b14-855662c0e47e",
"46116a62-b6f7-4939-8f78-d142b8f0657a"
]
}

Response samples

200

Content type

application/json

[{"$key": "582e0548-4e62-4bf3-9b14-855662c0e47e",
"$changedAt": "2023-09-08T09:20:10Z",
"$changedBy": "johndoe",
"$changedByName": "John Doe",
"region": "EMEA",
"billings": "1000000"
},
{"$key": "46116a62-b6f7-4939-8f78-d142b8f0657a",
"$changedAt": "2023-09-08T11:06:37Z",
"$changedBy": "willsmith",
"$changedByName": "Will Smith",
"region": "APAC",
"billings": "2000000"
}
]

Import instance data

This endpoint is used to bulk-import records into the forms instance. If any records already exist, those are overwritten and lost. If the import fails, the content of the instance will be either empty or containing the original records.

Status

Stable.

Authorization

Required permissions: IMPORT

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance

required

string

ID of form instance

Request Body schema:
application/json
required

All instance data

Array

$key	string Record key; when omitted or null, a new key will be generated on insert; when present, must be a non-empty string
$changedAt	string <date-time> ISO 8601 formatted timestamp of when the record was modified
$changedBy	string
$changedByName	string
$deleted	boolean
$isNew	boolean
property name* additional property	any

Responses

Request samples

Payload

Content type

application/json

[{"$key": "582e0548-4e62-4bf3-9b14-855662c0e47e",
"$changedAt": "2023-09-08T09:20:10Z",
"$changedBy": "johndoe",
"$changedByName": "John Doe",
"region": "EMEA",
"billings": "1000000"
},
{"$key": "46116a62-b6f7-4939-8f78-d142b8f0657a",
"$changedAt": "2023-09-08T11:06:37Z",
"$changedBy": "willsmith",
"$changedByName": "Will Smith",
"region": "APAC",
"billings": "2000000"
}
]

Import instance data as a background operation

This endpoint is used to bulk-import records into the forms instance. If any records already exist, those are overwritten and lost. If the import fails, the content of the instance will be either empty or containing the original records. The import starts once all data is transferred to the server and is performed as a background operation.

Status

Preview - request and response structure may change in future releases.

Authorization

Required permissions: IMPORT

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance

required

string

ID of form instance

Request Body schema:
application/json
required

All instance data

Array

$key	string Record key; when omitted or null, a new key will be generated on insert; when present, must be a non-empty string
$changedAt	string <date-time> ISO 8601 formatted timestamp of when the record was modified
$changedBy	string
$changedByName	string
$deleted	boolean
$isNew	boolean
property name* additional property	any

Responses

Request samples

Payload

Content type

application/json

[{"$key": "582e0548-4e62-4bf3-9b14-855662c0e47e",
"$changedAt": "2023-09-08T09:20:10Z",
"$changedBy": "johndoe",
"$changedByName": "John Doe",
"region": "EMEA",
"billings": "1000000"
},
{"$key": "46116a62-b6f7-4939-8f78-d142b8f0657a",
"$changedAt": "2023-09-08T11:06:37Z",
"$changedBy": "willsmith",
"$changedByName": "Will Smith",
"region": "APAC",
"billings": "2000000"
}
]

Response samples

200

Content type

application/json

{"id": "582e0548-4e62-4bf3-9b14-855662c0e47e",
"status": "queued"
}

Batch-upsert records

This endpoint is used to upsert (update or insert) multiple records with the same change. Multiple different changes can be submitted.

Status

Stable.

Authorization

Required permissions: WRITE

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance

required

string

ID of form instance

Request Body schema:
application/json
required

Array

keys required	Array of strings
modification required	object

Responses

Request samples

Payload

Content type

application/json

[{"keys": ["582e0548-4e62-4bf3-9b14-855662c0e47e",
"5e499891-a3cf-4f7e-ac9f-bd05d019320e",
""
],
"modification": {"billings": "1000000"
}
}
]

Form Planning

Query all records

This endpoint is used to query all records stored in the form instance. If the changelog parameter is sent and set to true, deleted records as well as older (changed) values of records will be included in the response.

Status

Stable - with the exception of the metadata field when application/vnd.inphinity-forms+json content type is used.

Authorization

Required permissions: READ

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance

required

string

ID of form instance

query Parameters

changelog	boolean Return full changelog
since	string <date-time> ISO 8601 formatted timestamp; only records newer than this timestamp will be returned

Responses

Response samples

200

Content type

text/xml

No sample

Upsert records

This endpoint is used to insert new records or update existing records.

Status

Stable - with the exception of the metadata field when application/vnd.inphinity-forms+json content type is used.

Authorization

Required permissions: WRITE

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance

required

string

ID of form instance

header Parameters

Prefer

string

The endpoint respects the return=minimal preference in HTTP Prefer header, as per RFC 7240. The client should specify this preference whenever the full response is not needed, as that may result in a performance optimization when inserting the records into the instance storage.

Request Body schema:
application/json
required

Array

$key	string Record key; when omitted or null, a new key will be generated on insert; when present, must be a non-empty string
$changedAt	string <date-time> ISO 8601 formatted timestamp of when the record was modified
$changedBy	string
$changedByName	string
$deleted	boolean
$isNew	boolean
property name* additional property	any

Responses

Request samples

Payload

Content type

application/json

[{"$key": "582e0548-4e62-4bf3-9b14-855662c0e47e",
"region": "EMEA",
"billings": "1000000"
},
{"region": "APAC",
"billings": "2000000"
}
]

Response samples

201

Content type

application/json

[{"$key": "582e0548-4e62-4bf3-9b14-855662c0e47e",
"$changedAt": "2023-09-30T09:20:10Z",
"$changedBy": "thisuser",
"$changedByName": "This User",
"region": "EMEA",
"billings": "1000000"
},
{"$key": "46116a62-b6f7-4939-8f78-d142b8f0657a",
"$changedAt": "2023-09-30T09:20:10Z",
"$changedBy": "thisuser",
"$changedByName": "This User",
"$isNew": true,
"region": "APAC",
"billings": "2000000"
}
]

Delete all records

This endpoint is used to completely remove all records stored in the forms instance, including the changelog.

Status

Stable - with the exception of the metadata field when application/vnd.inphinity-forms+json content type is used.

Authorization

Required permissions: PURGE

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance

required

string

ID of form instance

Responses

Delete a single record

This endpoint is used to delete a single record. If the underlying storage supports it, the record is only marked as deleted.

Status

Stable.

Authorization

Required permissions: WRITE

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance required	string ID of form instance
key required	string ID of record to delete

Responses

Query records by keys

This endpoint is used to query records stored in the form instance based on a list of record keys provided in the request. If the changelog parameter is sent and set to true, deleted records as well as previous values of records will be included in the response.

Status

Stable - with the exception of the metadata field when application/vnd.inphinity-forms+json content type is used.

Authorization

Required permissions: READ

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance

required

string

ID of form instance

Request Body schema:
application/json
required

Form query parameters

keys

required

Array of strings

List of record keys to query

Responses

Request samples

Payload

Content type

application/json

{"keys": ["582e0548-4e62-4bf3-9b14-855662c0e47e",
"46116a62-b6f7-4939-8f78-d142b8f0657a"
]
}

Response samples

200

Content type

application/json

[{"$key": "582e0548-4e62-4bf3-9b14-855662c0e47e",
"$changedAt": "2023-09-08T09:20:10Z",
"$changedBy": "johndoe",
"$changedByName": "John Doe",
"region": "EMEA",
"billings": "1000000"
},
{"$key": "46116a62-b6f7-4939-8f78-d142b8f0657a",
"$changedAt": "2023-09-08T11:06:37Z",
"$changedBy": "willsmith",
"$changedByName": "Will Smith",
"region": "APAC",
"billings": "2000000"
}
]

Import instance data

This endpoint is used to bulk-import records into the forms instance. If any records already exist, those are overwritten and lost.

Status

Stable.

Authorization

Required permissions: IMPORT

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance

required

string

ID of form instance

Request Body schema:
application/json
required

All instance data

Array

$key	string Record key; when omitted or null, a new key will be generated on insert; when present, must be a non-empty string
$changedAt	string <date-time> ISO 8601 formatted timestamp of when the record was modified
$changedBy	string
$changedByName	string
$deleted	boolean
$isNew	boolean
property name* additional property	any

Responses

Request samples

Payload

Content type

application/json

[{"$key": "582e0548-4e62-4bf3-9b14-855662c0e47e",
"$changedAt": "2023-09-08T09:20:10Z",
"$changedBy": "johndoe",
"$changedByName": "John Doe",
"region": "EMEA",
"billings": "1000000"
},
{"$key": "46116a62-b6f7-4939-8f78-d142b8f0657a",
"$changedAt": "2023-09-08T11:06:37Z",
"$changedBy": "willsmith",
"$changedByName": "Will Smith",
"region": "APAC",
"billings": "2000000"
}
]

Import instance data

This endpoint is used to bulk-import records into the forms instance. If any records already exist, those are overwritten and lost. The import starts once all data is transferred to the server and is performed as a background operation.

Status

Preview - request and response structure may change in future releases.

Authorization

Required permissions: IMPORT

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance

required

string

ID of form instance

Request Body schema:
application/json
required

All instance data

Array

$key	string Record key; when omitted or null, a new key will be generated on insert; when present, must be a non-empty string
$changedAt	string <date-time> ISO 8601 formatted timestamp of when the record was modified
$changedBy	string
$changedByName	string
$deleted	boolean
$isNew	boolean
property name* additional property	any

Responses

Request samples

Payload

Content type

application/json

[{"$key": "582e0548-4e62-4bf3-9b14-855662c0e47e",
"$changedAt": "2023-09-08T09:20:10Z",
"$changedBy": "johndoe",
"$changedByName": "John Doe",
"region": "EMEA",
"billings": "1000000"
},
{"$key": "46116a62-b6f7-4939-8f78-d142b8f0657a",
"$changedAt": "2023-09-08T11:06:37Z",
"$changedBy": "willsmith",
"$changedByName": "Will Smith",
"region": "APAC",
"billings": "2000000"
}
]

Response samples

200

Content type

application/json

{"id": "582e0548-4e62-4bf3-9b14-855662c0e47e",
"status": "queued"
}

Form Comment object

Query all comments

This endpoint is used to query all comments stored in the form instance. If the changelog parameter is sent and set to true, deleted comments as well as previous versions of comments will be included in the response.

Status

Preview - request and response structure may change in future releases.

Authorization

Required permissions: READ

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance

required

string

ID of form instance

query Parameters

changelog	boolean Return full changelog
lastInThread	string Return only last comment from only thread specified in the parameter (at most one per appId and objId).

Responses

Response samples

200

Content type

text/xml

No sample

Delete all comments

This endpoint is used to completely remove all comments stored in the forms instance, including the changelog.

Status

Stable.

Authorization

Required permissions: PURGE

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance

required

string

ID of form instance

Responses

Create a new comment

This endpoint is used to create a new comment.

Status

Preview - request and response structure may change in future releases.

Authorization

Required permissions: WRITE; adding a comment with pinned=true requires MODERATE permission.

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance

required

string

ID of form instance

Request Body schema:
application/json
required

key	string Record key; when omitted or null, a new key will be generated on insert; when present, must be a non-empty string
appId	string
objId	string
threadId required	string
text	string
	Array of objects (QlikSelection)
snapshots	Array of strings
attachments	Array of strings
tags	Array of strings
pinned required	boolean
deleted	boolean

Responses

Request samples

Payload

Content type

application/json

{"text": "New comment",
"appId": "83de-4c02-91eb-412dc16ad0ab",
"objId": "nqwe923",
"selections": [ ],
"snapshots": [ ],
"attachments": [ ],
"tags": [ ],
"pinned": false
}

Response samples

201

Content type

application/json

{"key": "2cb50a97-1547-4d1c-8ab1-f10b59dc743c",
"appId": "83de-4c02-91eb-412dc16ad0ab",
"objId": "nqwe923",
"createdAt": "2023-05-05T12:16:52Z",
"changedAt": "2023-05-05T12:16:52Z",
"createdBy": "wsmith",
"createdByName": "Will Smith",
"text": "New comment",
"selections": [ ],
"snapshots": [ ],
"attachments": [ ],
"tags": [ ],
"pinned": false,
"deleted": false,
"threadId": "",
"mentions": [ ]
}

Query all comments for a specific app and object

This endpoint is used to query all comments stored in the form instance that belong to the specified app and object. If the changelog parameter is sent and set to true, deleted comments as well as previous versions of comments will be included in the response.

Status

Preview - request and response structure may change in future releases.

Authorization

Required permissions: READ

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance

required

string

ID of form instance

Request Body schema:
application/json
required

appId required	string
objId	string
lastInThread	string

Responses

Request samples

Payload

Content type

application/json

{"appId": "83de-4c02-91eb-412dc16ad0ab",
"objId": "mn123ms"
}

Response samples

200

Content type

application/json

[{"key": "c6b173dd-83de-4c02-91eb-412dc16ad0ab",
"createdAt": "2023-05-05T11:56:48Z",
"createdBy": "jdoe",
"createdByName": "John Doe",
"changedAt": "2023-05-05T11:56:48Z",
"changedBy": "jdoe",
"changedByName": "John Doe",
"text": "Comment text",
"selections": [ ],
"snapshots": [ ],
"attachments": [ ],
"tags": [ ],
"pinned": false,
"deleted": false,
"threadId": "",
"appId": "83de-4c02-91eb-412dc16ad0ab",
"objId": "mn123ms",
"mentions": [ ]
},
{"key": "2cb50a97-1547-4d1c-8ab1-f10b59dc743c",
"createdAt": "2023-05-05T12:16:52Z",
"createdBy": "wsmith",
"createdByName": "Will Smith",
"changedAt": "2023-05-05T12:16:52Z",
"changedBy": "wsmith",
"changedByName": "Will Smith",
"text": "Another comment",
"selections": [ ],
"snapshots": [ ],
"attachments": [ ],
"tags": [ ],
"pinned": false,
"deleted": false,
"threadId": "",
"appId": "83de-4c02-91eb-412dc16ad0ab",
"objId": "mn123ms",
"mentions": [ ]
}
]

Import comment instance data

This endpoint is used to bulk-import comment records into the forms instance. If any records already exist, those are overwritten and lost.

Status

Stable.

Authorization

Required permissions: IMPORT

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance

required

string

ID of form instance

Request Body schema:
application/json
required

All instance data

Array

createdAt	string <date-time> ISO 8601 formatted timestamp of when the record was created
createdBy	string
createdByName	string
changedAt	string <date-time> ISO 8601 formatted timestamp of when the record was modified
changedBy	string
changedByName	string
	Array of objects (BasicUserInfo)
key	string Record key; when omitted or null, a new key will be generated on insert; when present, must be a non-empty string
appId	string
objId	string
threadId required	string
text	string
	Array of objects (QlikSelection)
snapshots	Array of strings
attachments	Array of strings
tags	Array of strings
pinned required	boolean
deleted	boolean

Responses

Request samples

Payload

Content type

application/json

[{"createdAt": "2023-07-25T09:10:32.00042+02:00",
"createdBy": "string",
"createdByName": "string",
"changedAt": "2023-07-25T09:10:32.00042+02:00",
"changedBy": "string",
"changedByName": "string",
"mentions": [{"userId": "string",
"userName": "string",
"userDirectory": "string"
}
],
"key": "string",
"appId": "string",
"objId": "string",
"threadId": "string",
"text": "string",
"selections": [{"qField": "string",
"values": ["string"
]
}
],
"snapshots": ["string"
],
"attachments": ["string"
],
"tags": ["string"
],
"pinned": true,
"deleted": true
}
]

Import comment instance data

This endpoint is used to bulk-import comment records into the forms instance. If any records already exist, those are overwritten and lost.

Status

Preview - request and response structure may change in future releases.

Authorization

Required permissions: IMPORT

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance

required

string

ID of form instance

Request Body schema:
application/json
required

All instance data

Array

createdAt	string <date-time> ISO 8601 formatted timestamp of when the record was created
createdBy	string
createdByName	string
changedAt	string <date-time> ISO 8601 formatted timestamp of when the record was modified
changedBy	string
changedByName	string
	Array of objects (BasicUserInfo)
key	string Record key; when omitted or null, a new key will be generated on insert; when present, must be a non-empty string
appId	string
objId	string
threadId required	string
text	string
	Array of objects (QlikSelection)
snapshots	Array of strings
attachments	Array of strings
tags	Array of strings
pinned required	boolean
deleted	boolean

Responses

Request samples

Payload

Content type

application/json

[{"createdAt": "2023-07-25T09:10:32.00042+02:00",
"createdBy": "string",
"createdByName": "string",
"changedAt": "2023-07-25T09:10:32.00042+02:00",
"changedBy": "string",
"changedByName": "string",
"mentions": [{"userId": "string",
"userName": "string",
"userDirectory": "string"
}
],
"key": "string",
"appId": "string",
"objId": "string",
"threadId": "string",
"text": "string",
"selections": [{"qField": "string",
"values": ["string"
]
}
],
"snapshots": ["string"
],
"attachments": ["string"
],
"tags": ["string"
],
"pinned": true,
"deleted": true
}
]

Response samples

200

Content type

application/json

{"id": "582e0548-4e62-4bf3-9b14-855662c0e47e",
"status": "queued"
}

Update a comment

This endpoint is used to update a comment. Users can only update their own comments.

Status

Preview - request and response structure may change in future releases.

Authorization

Required permissions: WRITE; user can only update comments created by the same user. Change of the pinned flag is only allowed for users with MODERATE permission.

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance required	string ID of form instance
key required	string ID of comment record

Request Body schema:
application/json
required

key	string Record key; when omitted or null, a new key will be generated on insert; when present, must be a non-empty string
appId	string
objId	string
threadId required	string
text	string
	Array of objects (QlikSelection)
snapshots	Array of strings
attachments	Array of strings
tags	Array of strings
pinned required	boolean
deleted	boolean

Responses

Request samples

Payload

Content type

application/json

{"key": "2cb50a97-1547-4d1c-8ab1-f10b59dc743c",
"text": "Modified comment",
"selections": [ ],
"snapshots": [ ],
"attachments": [ ],
"tags": [ ],
"pinned": false,
"threadId": ""
}

Response samples

201

Content type

application/json

{"key": "2cb50a97-1547-4d1c-8ab1-f10b59dc743c",
"createdAt": "2023-09-05T12:20:00Z",
"createdBy": "thisuser",
"createdByName": "This user",
"changedAt": "2023-09-05T12:30:00Z",
"changedBy": "thisuser",
"changedByName": "This user",
"text": "Modified comment",
"selections": [ ],
"snapshots": [ ],
"attachments": [ ],
"tags": [ ],
"pinned": false,
"deleted": false,
"threadId": "",
"mentions": [ ]
}

Delete a comment

This endpoint is used to delete a single comment. A user can only delete comments created by the same user. A moderator can delete any comment.

Status

Stable.

Authorization

Required permissions: WRITE; to delete other users' comments, MODERATE is required.

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance required	string ID of form instance
key required	string ID of comment record

Responses

Attachment upload/download

Upload a file

This endpoint is used to store a new attachment. Request body is a multipart and the file to be attached must be sent in a part with name 'file'.

Status

Stable.

Authorization

Required permissions: WRITE

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance

required

string

ID of upload form instance

query Parameters

subfolder

string

Subfolder to store the attachment in

Request Body schema: multipart/form-data
required

string <binary>

Responses

Response samples

201

Content type

application/json

"upload-3238376705641966890-origfile.docx"

Download attachment

This endpoint is used to download an attachment. The content type of the response is always application/octet-stream, so that the browser does not attempt to render the file but instead offers the user to save it.

Status

Stable.

Authorization

Required permissions: READ

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance required	string ID of upload form instance
attachmentId required	string ID of attachment

query Parameters

subfolder

string

Subfolder the attachment is stored in

Responses

View attachment

This endpoint is used to view an attachment. The content type of the response should match the actual type of the file, so that the browser attempts to render the file instead of saving it as a file.

Status

Stable.

Authorization

Required permissions: READ

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance required	string ID of upload form instance
attachmentId required	string ID of attachment

query Parameters

subfolder

string

Subfolder the attachment is stored in

Responses

Delete an attachment

This endpoint is used to delete a stored attachment.

Status

Stable.

Authorization

Required permissions: WRITE

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance required	string ID of upload form instance
attachmentId required	string ID of attachment

query Parameters

subfolder

string

Subfolder the attachment is stored in

Responses

Administration related

Get all instances

This endpoint is used to query all or requested configured forms instances. When the id parameter is specified, the specified form instances configurations are returned. Otherwise, all instances configurations are returned.

Status

Preview - request and response structure may change in future releases.

Authorization

Required permissions: READ on 'configForms' instance or membership in ADMIN group.

Authorizations:

JwtTokenQlikCookie

query Parameters

id	Array of strings IDs of forms instances to return.

Responses

Response samples

200

Content type

application/json

[{"type": "general",
"id": "form1",
"createdAt": "2023-04-06T12:35:13Z",
"readGroups": [ ],
"readWriteGroups": [ ],
"moderateGroups": [ ],
"note": "",
"createdBy": "someuser",
"collaboration": true,
"xml": "form1.xml"
}
]

Create new instance

This endpoint is used to configure a new forms instance.

Status

Preview - request and response structure may change in future releases.

Authorization

Required permissions: WRITE on 'configForms' instance or membership in ADMIN group.

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance

required

string

ID of form instance

Request Body schema:
application/json

xml required	string
id	string
type	string general
readGroups	Array of strings
readWriteGroups	Array of strings
moderateGroups	Array of strings
mentioneeGroups	Array of strings
createdBy	string
createdAt	string <date-time> ISO 8601 formatted timestamp of when the instance was created
changedBy	string
changedAt	string <date-time> ISO 8601 formatted timestamp of when the instance was last modified
note	string
collaboration	boolean
changelog	boolean
softDelete	boolean

Responses

Request samples

Payload

Content type

application/json

{"type": "general",
"id": "form1",
"readGroups": [ ],
"readWriteGroups": [ ],
"moderateGroups": [ ],
"note": "",
"collaboration": true,
"xml": "form1.xml"
}

Response samples

201

Content type

application/json

{"type": "general",
"id": "form1",
"createdAt": "2023-04-06T12:35:13Z",
"readGroups": [ ],
"readWriteGroups": [ ],
"moderateGroups": [ ],
"note": "",
"createdBy": "thisuser",
"collaboration": true,
"xml": "form1.xml"
}

Update instance

This endpoint is used to modify a forms instance configuration.

Status

Preview - request and response structure may change in future releases.

Authorization

Required permissions: WRITE on 'configForms' instance or membership in ADMIN group.

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance

required

string

ID of form instance

Request Body schema:
application/json

xml required	string
id	string
type	string general
readGroups	Array of strings
readWriteGroups	Array of strings
moderateGroups	Array of strings
mentioneeGroups	Array of strings
createdBy	string
createdAt	string <date-time> ISO 8601 formatted timestamp of when the instance was created
changedBy	string
changedAt	string <date-time> ISO 8601 formatted timestamp of when the instance was last modified
note	string
collaboration	boolean
changelog	boolean
softDelete	boolean

Responses

Request samples

Payload

Content type

application/json

{"type": "general",
"id": "form1",
"readGroups": [ ],
"readWriteGroups": [ ],
"moderateGroups": [ ],
"note": "Added note",
"collaboration": true,
"xml": "other/form1.xml"
}

Response samples

200

Content type

application/json

{"type": "general",
"id": "form1",
"createdAt": "2023-04-06T12:35:13Z",
"readGroups": [ ],
"readWriteGroups": [ ],
"moderateGroups": [ ],
"note": "Added note",
"createdBy": "someuser",
"collaboration": true,
"xml": "other/form1.xml"
}

Delete instance

This endpoint is used to remove a forms instance configuration.

Status

Preview - request and response structure may change in future releases.

Authorization

Required permissions: WRITE on 'configForms' instance or membership in ADMIN group.

Authorizations:

JwtTokenQlikCookie

path Parameters

formInstance

required

string

ID of form instance

query Parameters

removeStoredData

boolean

Remove stored data - i.e. remove (rename to indicate removal) the underlying XML or QVD file or MongoDB collection

Responses

Get all datasources

This endpoint is used to query all or requested configured datasources. When the owner parameter is specified, datasources with a matching owner are returned. Otherwise, all datasources are returned.

Status

Preview - request and response structure may change in future releases.

Authorization

Required permissions: READ on 'configForms' instance or membership in ADMIN group.

Authorizations:

JwtTokenQlikCookie

query Parameters

owner

required

string

Only datasources with a matching owner are returned.

Responses

Response samples

200

Content type

application/json

[{"connectionString": "string",
"driver": "string",
"trustedCertificates": "string",
"sqlDriverMode": false,
"sqlInit": ["string"
],
"sqlCommit": ["string"
],
"id": "string",
"type": "sql",
"name": "string",
"note": "string",
"credentials": [{"username": "string",
"encryptedPassword": "string",
"hasPassword": true,
"type": "up",
"id": "string",
"note": "string"
}
],
"activeCredentialsId": "string",
"owner": "string",
"metadata": { },
"createdBy": "string",
"createdAt": "2023-07-25T09:10:32.00042+02:00",
"changedBy": "string",
"changedAt": "2023-07-25T09:10:32.00042+02:00"
}
]

Create a new datasource

This endpoint is used to configure a new datasource.

Status

Preview - request and response structure may change in future releases.

Authorization

Required permissions: WRITE on 'configForms' instance or membership in ADMIN group.

Authorizations:

JwtTokenQlikCookie

Request Body schema:
application/json

Credentials are ignored in the request body. Use separate calls to manage credentials. ID is ignored and a new one is generated.

connectionString required	string
driver	string
trustedCertificates	string
sqlDriverMode	boolean Default: false
sqlInit	Array of strings
sqlCommit	Array of strings
id required	string
type required	string sql
name	string
note	string
	Array of any (Credentials)
activeCredentialsId	string
owner	string Typically the tenant id
metadata	object
createdBy	string
createdAt	string <date-time> ISO 8601 formatted timestamp of when the datasource was created
changedBy	string
changedAt	string <date-time> ISO 8601 formatted timestamp of when the datasource was changed

Responses

Request samples

Payload

Content type

application/json

{"connectionString": "string",
"driver": "string",
"trustedCertificates": "string",
"sqlDriverMode": false,
"sqlInit": ["string"
],
"sqlCommit": ["string"
],
"id": "string",
"type": "sql",
"name": "string",
"note": "string",
"credentials": [{"username": "string",
"encryptedPassword": "string",
"hasPassword": true,
"type": "up",
"id": "string",
"note": "string"
}
],
"activeCredentialsId": "string",
"owner": "string",
"metadata": { },
"createdBy": "string",
"createdAt": "2023-07-25T09:10:32.00042+02:00",
"changedBy": "string",
"changedAt": "2023-07-25T09:10:32.00042+02:00"
}

Response samples

201

Content type

application/json

{"connectionString": "string",
"driver": "string",
"trustedCertificates": "string",
"sqlDriverMode": false,
"sqlInit": ["string"
],
"sqlCommit": ["string"
],
"id": "string",
"type": "sql",
"name": "string",
"note": "string",
"credentials": [{"username": "string",
"encryptedPassword": "string",
"hasPassword": true,
"type": "up",
"id": "string",
"note": "string"
}
],
"activeCredentialsId": "string",
"owner": "string",
"metadata": { },
"createdBy": "string",
"createdAt": "2023-07-25T09:10:32.00042+02:00",
"changedBy": "string",
"changedAt": "2023-07-25T09:10:32.00042+02:00"
}

Query a datasource

This endpoint is used to query a datasource.

Status

Preview - request and response structure may change in future releases.

Authorization

Required permissions: READ on 'configForms' instance or membership in ADMIN group.

Authorizations:

JwtTokenQlikCookie

path Parameters

datasource

required

string

ID of a datasource

query Parameters

owner

required

string

Must match the datasource's owner.

Responses

Response samples

200

Content type

application/json

{"connectionString": "string",
"driver": "string",
"trustedCertificates": "string",
"sqlDriverMode": false,
"sqlInit": ["string"
],
"sqlCommit": ["string"
],
"id": "string",
"type": "sql",
"name": "string",
"note": "string",
"credentials": [{"username": "string",
"encryptedPassword": "string",
"hasPassword": true,
"type": "up",
"id": "string",
"note": "string"
}
],
"activeCredentialsId": "string",
"owner": "string",
"metadata": { },
"createdBy": "string",
"createdAt": "2023-07-25T09:10:32.00042+02:00",
"changedBy": "string",
"changedAt": "2023-07-25T09:10:32.00042+02:00"
}

Update a datasource

This endpoint is used to update a datasource.

Status

Preview - request and response structure may change in future releases.

Authorization

Required permissions: WRITE on 'configForms' instance or membership in ADMIN group.

Authorizations:

JwtTokenQlikCookie

path Parameters

datasource

required

string

ID of a datasource

query Parameters

owner

required

string

Must match the datasource's owner.

Request Body schema:
application/json

Credentials are ignored in the request body. Use separate calls to manage credentials.

connectionString required	string
driver	string
trustedCertificates	string
sqlDriverMode	boolean Default: false
sqlInit	Array of strings
sqlCommit	Array of strings
id required	string
type required	string sql
name	string
note	string
	Array of any (Credentials)
activeCredentialsId	string
owner	string Typically the tenant id
metadata	object
createdBy	string
createdAt	string <date-time> ISO 8601 formatted timestamp of when the datasource was created
changedBy	string
changedAt	string <date-time> ISO 8601 formatted timestamp of when the datasource was changed

Responses

Request samples

Payload

Content type

application/json

{"connectionString": "string",
"driver": "string",
"trustedCertificates": "string",
"sqlDriverMode": false,
"sqlInit": ["string"
],
"sqlCommit": ["string"
],
"id": "string",
"type": "sql",
"name": "string",
"note": "string",
"credentials": [{"username": "string",
"encryptedPassword": "string",
"hasPassword": true,
"type": "up",
"id": "string",
"note": "string"
}
],
"activeCredentialsId": "string",
"owner": "string",
"metadata": { },
"createdBy": "string",
"createdAt": "2023-07-25T09:10:32.00042+02:00",
"changedBy": "string",
"changedAt": "2023-07-25T09:10:32.00042+02:00"
}

Response samples

201

Content type

application/json

{"connectionString": "string",
"driver": "string",
"trustedCertificates": "string",
"sqlDriverMode": false,
"sqlInit": ["string"
],
"sqlCommit": ["string"
],
"id": "string",
"type": "sql",
"name": "string",
"note": "string",
"credentials": [{"username": "string",
"encryptedPassword": "string",
"hasPassword": true,
"type": "up",
"id": "string",
"note": "string"
}
],
"activeCredentialsId": "string",
"owner": "string",
"metadata": { },
"createdBy": "string",
"createdAt": "2023-07-25T09:10:32.00042+02:00",
"changedBy": "string",
"changedAt": "2023-07-25T09:10:32.00042+02:00"
}

Delete datasource

This endpoint is used to remove a datasource configuration.

Status

Preview - request and response structure may change in future releases.

Authorization

Required permissions: WRITE on 'configForms' instance or membership in ADMIN group.

Authorizations:

JwtTokenQlikCookie

path Parameters

datasource

required

string

ID of a datasource

query Parameters

owner

required

string

Must match the datasource's owner.

Responses

Test a datasource

This endpoint is used to test a datasource. Unless credentialsId is specified in the query, currently active credentials will be used. Returns an empty body with 200 status on success, or 500 with ProblemDetail in the body.

Status

Preview - request and response structure may change in future releases.

Authorization

Required permissions: READ on 'configForms' instance or membership in ADMIN group.

Authorizations:

JwtTokenQlikCookie

path Parameters

datasource

required

string

ID of a datasource

query Parameters

owner required	string Must match the datasource's owner.
credentialsId	string

Responses

Add new credentials to a datasource

This endpoint is used to add new credentials to a datasource.

Status

Preview - request and response structure may change in future releases.

Authorization

Required permissions: WRITE on 'configForms' instance or membership in ADMIN group.

Authorizations:

JwtTokenQlikCookie

path Parameters

datasource

required

string

ID of a datasource

query Parameters

owner

required

string

Must match the datasource's owner.

Request Body schema:
application/json

username	string
encryptedPassword	string for updates
hasPassword	boolean for query responses
type required	string up
id	string only used in query response, for new credentials backend assigns ID
note	string

Responses

Request samples

Payload

Content type

application/json

Example

up

{"username": "string",
"encryptedPassword": "string",
"hasPassword": true,
"type": "up",
"id": "string",
"note": "string"
}

Response samples

201

Content type

application/json

Example

up

{"username": "string",
"encryptedPassword": "string",
"hasPassword": true,
"type": "up",
"id": "string",
"note": "string"
}

Delete datasource's credentials

This endpoint is used to remove a datasource's credentials.

Status

Preview - request and response structure may change in future releases.

Authorization

Required permissions: WRITE on 'configForms' instance or membership in ADMIN group.

Authorizations:

JwtTokenQlikCookie

path Parameters

datasource required	string ID of a datasource
credentialId required	string id slot of credential

query Parameters

owner

required

string

Must match the datasource's owner.

Responses

Get public key

This endpoint is used to query the GPG public key used for credential (SQL database password) encryption.

Authorization

Required permissions: None (user must be authenticated).

Authorizations:

JwtTokenQlikCookie

Responses

Get all user-defined groups

This endpoint is used to query all user-defined groups.

Status

Preview - request and response structure may change in future releases.

Authorization

Required permissions: READ on 'configForms' instance or membership in ADMIN group.

Authorizations:

JwtTokenQlikCookie

Responses

Response samples

200

Content type

application/json

[{"name": "string",
"note": "string"
}
]

Set user-defined groups

This endpoint is used to set all user-defined groups.

Status

Preview - request and response structure may change in future releases.

Authorization

Required permissions: WRITE on 'configForms' instance or membership in ADMIN group.

Authorizations:

JwtTokenQlikCookie

Request Body schema:
application/json
required

Array

name required	string
note	string

Responses

Request samples

Payload

Content type

application/json

[{"name": "string",
"note": "string"
}
]

Response samples

201

Content type

application/json

[{"name": "string",
"note": "string"
}
]

Server health check

This endpoint reports simple health status of the forms server.

Status

Stable.

Authorization

No authentication or authorization is required.

Responses

misc

Query background job status

This endpoint is used to query status of a background job.

Status

Preview - request and response structure may change in future releases.

Authorizations:

JwtTokenQlikCookie

path Parameters

jobId

required

string

ID background job

Responses

Response samples

200

Content type

application/json

{"id": "582e0548-4e62-4bf3-9b14-855662c0e47e",
"status": "queued"
}

Inphinity Forms (API v2)

Form General

Query all records

Status

Authorization

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Upsert records

Status

Authorization

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonapplication/vnd.inphinity-forms+jsonapplication/jsonrequired

Responses

Request samples

Response samples

Batch-upsert records

Status

Authorization

Authorizations:

path Parameters

Request Body schema: application/jsonapplication/vnd.inphinity-forms+jsonapplication/jsonrequired

Responses

Request samples

Delete all records

Status

Authorization

Authorizations:

path Parameters

Responses

Delete a single record

Status

Authorization

Authorizations:

path Parameters

Responses

Query records by keys

Status

Authorization

Authorizations:

path Parameters

Request Body schema: application/jsonapplication/vnd.inphinity-forms+jsonapplication/jsonrequired

Responses

Request samples

Response samples

Import instance data

Status

Authorization

Authorizations:

path Parameters

Request Body schema: application/jsontext/xmlapplication/jsonrequired

Responses

Request samples

Import instance data as a background operation

Status

Authorization

Authorizations:

path Parameters

Request Body schema: application/jsontext/xmlapplication/jsonrequired

Responses

Request samples

Response samples

Batch-upsert records

Status

Authorization

Authorizations:

path Parameters

Request Body schema: application/jsonapplication/vnd.inphinity-forms+jsonapplication/jsonrequired

Responses

Request samples

Form Planning

Query all records

Status

Authorization

Authorizations:

path Parameters

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required