API docs by Redocly

UNICOM Intelligence Web API (1.1)

Download OpenAPI specification:Download

Unified RESTful API for programmatic access to UNICOM Intelligence

CaseData.Download

Retrieve the results of a query of the case data as a CSV file with the mrOleDb SQL query as a query parameter.

If no query is specified then all fields and cases are returned

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project to query

query Parameters
sql
string or null
Example: sql=SELECT * FROM VDATA

The mrOleDb SQL query to run to select the required fields and cases

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Retrieve the results of a query of the case data as a CSV file with the mrOleDb SQL query as the request body.

If no query is specified then all fields and cases are returned

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project to query

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Request Body schema: application/json

The mrOleDb SQL query to run to select the required fields and cases

string or null

Responses

Request samples

Content type
application/json
"SELECT * FROM VDATA"

CaseData.Statement

Execute a statement that is not expected to produce a result set (e.g. UPDATE, INSERT, or DELETE)

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Request Body schema: application/json

The mrOleDb SQL statement to execute

string or null

Responses

Request samples

Content type
application/json
"UPDATE VDATA SET Respondent.Id = 'TestId' WHERE Respondent.Serial = 1"

Response samples

Content type
application/json
0
0

CaseData.Upload

Upload new case data in CSV format

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The name of the project

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Request Body schema: text/csv
string <binary>

Responses

CaseData.Query

Retrieve the results of the case data query as a single response

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project to query

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Request Body schema: application/json

The mrOleDb SQL query to execute

string or null

Responses

Request samples

Content type
application/json
"SELECT * FROM VDATA"

Response samples

Content type
application/json
{
  • "columns": {
    },
  • "rows": [
    ]
}

Retrieve the results of the case data query as a single response

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project to query

query Parameters
sql
required
string or null
Example: sql=SELECT * FROM VDATA

The mrOleDb SQL query to execute

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "columns": {
    },
  • "rows": [
    ]
}

Retrieve the queries that are currently active for the current user

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Execute a new query

Once a query has been created the allocated "id" and the column names for the result set will be returned. The rows of the result set can be retrieved in pages by repeatily posting "Next" until there are no more rows to retrieve.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Request Body schema: application/json

The mrOleDb SQL query

One of
sql
required
string non-empty

An mrOleDb SQL query or statement

userName
string or null

The name of the user that created the query

pageSize
integer or null <int32>

The number of rows to be returned in each response

expiryTime
integer or null <int32>

The UTC time when the query will expiry due to inactivity and will be closed.

Responses

Request samples

Content type
application/json
{
  • "SQL": "SELECT * FROM VDATA",
  • "UserName": "DPMAdmin",
  • "PageSize": 200
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "sql": "string",
  • "expiryTime": "2019-08-24T14:15:22Z",
  • "pageSize": 0,
  • "columns": {
    }
}

Retrieve the details of an active query.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

queryId
required
string or null
Example: a91d14ff-6f53-4be6-ba10-62a7a5b14123

The id of the active query

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "sql": "string",
  • "expiryTime": "2019-08-24T14:15:22Z",
  • "pageSize": 0,
  • "columns": {
    }
}

Delete a query that is no longer required without retrieving all rows in the result set.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

queryId
required
string or null
Example: a91d14ff-6f53-4be6-ba10-62a7a5b14123

The id of an active query

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Retrieves the next set of rows in the result set

If the response contain the last set of rows in the result set then the query is automatically deleted and a 204 "No Content" response is set. If the client is not going to retrieve all rows of the result set then the query should be terminated by deleting the query id in order to release the server resources associated with the query.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

queryId
required
string or null
Example: a91d14ff-6f53-4be6-ba10-62a7a5b14123

The id of an active query

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a summary of the case data contents

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "columns": {
    },
  • "rows": [
    ]
}

CaseData.Schemas

Retrieve details of tables (VDATA or HDATA) within the case data

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "columns": {
    },
  • "rows": [
    ]
}

Retrieve details of the columns within case data table

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "columns": {
    },
  • "rows": [
    ]
}

Retrieve details of the data types used within the case data

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "columns": {
    },
  • "rows": [
    ]
}

DPM.CustomerAccounts

Retrieve details of all customer accounts visible to the current user

An administrator can view all customer accounts for the site, a non-administrator can only view the details for the customer account that the user belongs to.

Authorizations:
openIdConnect
header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve details of a specific customer account

An administrator can view all customer accounts for the site, a non-administrator can only view the details for the customer account that the user belongs to.

Authorizations:
openIdConnect
path Parameters
customerAccountId
required
string or null
Example: 45CF154C-A138-447A-B417-65728D84C899

The customer account id

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "displayName": "string",
  • "createdOn": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "isDisabled": true,
  • "description": "string"
}

DPM.ProjectProperties

Retrieve project properties or a single project property

The path can be null to retrieve the root project properties. If recursive is false then property collections are represented as an empty object in the response can can be retrieved in subsequent requests by supplying the path (using '/' as a path separator)

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

query Parameters
path
string or null
Example: path=mrInterview/InterviewStartURL

The path to the child property or properties collection to retrieve

recursive
boolean
Default: false

If True then all child properties collections are also retrieved

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Response samples

Content type
application/json
null

Delete a project property or properties collection

The named property must exist.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

query Parameters
path
string or null
Example: path=mrInterview/MyTestProperty

The property name, properties collection name, or path to the property to be deleted

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Add or update an existing property or properties collection

The new value for the property should be included as JSON in the request body. If the property doesn't already exist then it is created.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

query Parameters
path
required
string or null
Example: path=mrInterview/MyTestProperty

The property name, properties collection name, or path to the property to be added/updated

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Request Body schema: application/json

The new value for the property

any or null

Responses

Request samples

Content type
application/json
"NewPropValue"

DPM.Projects

The names of the projects accessible by the current user.

The list of project names can be filtered to a specific customer account id by specifying a CustomerAccountID query parameter. The list of project names can also be filtered to exclude projects with a status of "test", "inactive", or "active" by specifying the status as a ExcludeStatus query parameter. Multiple statuses can be excluded by specifying them as a comma delimited list, e.g. to show only active projects use "ExcludeStatus=Test,Inactive".

Authorizations:
openIdConnect
query Parameters
customerAccountId
string or null

The customer account id to filter the project names by

excludeStatus
string or null

Any project statuses to be excluded, delimited by , | or ;

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Response samples

Content type
application/json
[
  • "string"
]

The project folders accessible by the current user.

The list of project folders can be filtered to a specific customer account id by specifying a CustomerAccountID query parameter. The list of project folders can also be filtered to exclude folders that solely contain projects with a status of "test", "inactive", or "active" by specifying the status as a ExcludeStatus query parameter. Multiple statuses can be excluded by specifying them as a comma delimited list, e.g.to show only active projects use "ExcludeStatus=Test,Inactive". The list of folders is returned as a list of objects with a single property of "FolderName" in order to allow further properties of the folder to be added in the future.

Authorizations:
openIdConnect
query Parameters
customerAccountId
string or null

The customer account id to filter the project folders by

excludeStatus
string or null

Any project statuses to be excluded, delimited by , | or ;

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve the details of all customer accounts fulfilling the conditions of the query parameters.

The list of projects retrieved will be filtered using the customerAccountId, folderName, excludeStatus, and filter query parameters. Additional query properties can also be specified to filter the list of projects. The additional query properties can be any property of the ProjectDetails object, any DPM root level project property, or any property in the mrInterview property collection (including the mrInterview name in the path). If the query parameter does not exist for any project then it is treated as being Null. For example, ProjectLockedBy=DPMAdmin&mrInterview\MonitoringAllowed=1

If no folderName is specified then the folder name isn't used as a filter. If an empty string is specified for the folder name, e.g. \Projects?FolderName=, then only projects that don't exist in a folder will be returned.

The filter parameter is an mrEvaluate filter expression - any strings should be included in single quotes and any identifiers that use a reserved character, e.g. , will need to be enclosed in braces, e.g. [mrInterview\MonitoringAllowed]. The identifiers used in the filter expression can be any property of the ProjectDetails object, any DPM root level project property, or any property in the mrInterview property collection (including the mrInterview name in the path). If the identifer does not exist for any project then it is treated as being Null.

Where possible it is recommended that the customerAccountId, folderName, and excludeStatus parameters be used to reduce the set of possible projects that the filter criteria needs to be applied to.

Authorizations:
openIdConnect
query Parameters
customerAccountId
string or null

The customer account id to filter the project by

folderName
string or null

The folder name to filter the projects by

excludeStatus
string or null

Any project statuses to be excluded, delimited by , | or ;

filter
string or null

An mrEvaluate expression used to filter the projects

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

The same as GET /Projects but with the filter expression posted as the request body.

Authorizations:
openIdConnect
query Parameters
customerAccountId
string or null
folderName
string or null
excludeStatus
string or null
header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Request Body schema: application/json
string or null

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve the details of a single project

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "label": "string",
  • "status": "string",
  • "description": "string",
  • "customerAccountId": "string",
  • "folderName": "string",
  • "creator": "string",
  • "owner": "string",
  • "projectLocked": true,
  • "projectLockedBy": "string",
  • "sampleManagementName": "string",
  • "quotaProjectName": "string",
  • "isPhone": true,
  • "isPersonal": true
}

DPM.TimeZones

Retrieve a list of all time zones

Authorizations:
openIdConnect
header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve the details of a single time zone

Authorizations:
openIdConnect
path Parameters
timeZoneIndex
required
integer <int32>
Example: 290

The numeric index of the timezone

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "index": 0,
  • "displayName": "string",
  • "baseUtcOffset": "string",
  • "standardName": "string",
  • "daylightName": "string",
  • "supportsDaylightSavingTime": true,
  • "adjustmentRules": [
    ]
}

DPM.UserDetails

Retrieve the details of the current user

Authorizations:
openIdConnect
header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "isAdministrator": true,
  • "isCustomerAccountAdministrator": true,
  • "customerAccountId": "string",
  • "customerAccountName": "string",
  • "customerAccountDisplayName": "string",
  • "properties": {
    }
}

ExportData

Export the metadata and case data for a project

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

query Parameters
format
string or null
Example: format=mrDataFileDsc

The output format for the exported data, specified as a CDSC name

fileType
string or null
Example: fileType=ddf

The specific output file type for the CDSC in case the CDSC supports multiple file types

options
string (ExportDataRequestOptions)
Enum: "none" "ignoreFieldsNotSupportedByOutputFormat" "recheckOutSharedMetadataIfNewer"
Example: options=none

Options for the export that are not specific to the output format

variableTypes
string (VariableTypes)
Enum: "none" "text" "categorical" "real" "long" "bool" "date" "categoricalWithOther" "all"
Example: variableTypes=all

The variable types that should be included in the exported data

systemVariables
string (SystemVariableCategory)
Enum: "none" "common" "all"
Example: systemVariables=all

The category of system variables to include in the export

recordTypeFilter
string (RecordType)
Enum: "respondentData" "testData" "all"
Example: recordTypeFilter=all

The record type filter: Respondent, Test, or All

dataCollectionStatusFilter
string (DataCollectionStatuses)
Enum: "none" "completed" "active" "timedOut" "stoppedByScript" "stoppedByRespondent" "interviewSystemShutdown" "signal" "reviewed" "all"
Example: dataCollectionStatusFilter=all

The DataCollection.Status filter to apply

selectedPresetFilter
string or null
Example: selectedPresetFilter=Yesterday

The name of a predefined filter that should be applied

filterExpression
string or null

The custom mrEvaluate filter expression to apply to the case data

startDateTime
string or null <date-time>

The date which cases have to be collected after to get export. If Null then no restriction is applied.

endDateTime
string or null <date-time>

The date which cases have to be collected before to get export. If Null then no restriction is applied.

version
string or null

The metadata version to export. If this is not specified the "DefaultVersion" setting for the DPM application will be used. If that is not set then the superversion, {..}, will be export

language
string or null
Example: language=en-US

The metadata language to export. This sets the base and current langauge of the output MDD. It may also affect the language of the data exported depending on the export format. Defaults to the Accept-Language query parameter. If that does not exist then current langauge of the input metadata is used

context
string or null

The metadata context to export. If this is not specified the "DefaultContext" setting for the DPM application will be used. If that is not set then the "Analysis" context will be used.

labelType
string or null

The metadata label type to export.

inputCustomProperties
string or null

Custom data link properties ("MR Init Custom") for the input data source

outputCustomProperties
string or null

Custom data link properties ("MR Init Custom") for the output data source

timeZoneLocalization
string (TimeZoneLocalization)
Enum: "none" "server" "respondent" "custom"
Example: timeZoneLocalization=none

Controls the generation and localisation of the DataCollection_StartTime_Exported / DataCollection_FinishTime_Exported columns which localise the DataCollection.StartTime / DataCollection.FinishTime

customTimeZone
string or null

The time zone for the DataCollection_StartTime_Exported / DataCollection_FinishTime_Exported columns if TimeZoneLocalization is set to Custom

useCategoryNames
boolean

If True then category names will export instead of category values, if this is applicable to the output format. Default is False. (Applies to "Delimited Text File" only)

useSavShortNames
boolean

If True then short names will be used when exporting to SAV files. (Applies to mrSavDsc only)

clearCardColAllocations
boolean

If True and the data source has card/column allocations (for mrPunchDsc) then these are cleared during the export. Default is False. (Only applies to mrPunchDsc and only if the input has existing mrPunchDsc data)

widthOfSerialNumber
integer <int32>

The width of the serial number if the export is to a card-column format. (Applies to mrPunchDsc only)

widthOfCardNumber
integer <int32>

The width of the card number if the export is to a card-column format. (Applies to mrPunchDsc only)

maxCardLength
integer <int32>

The max length of a card if the export is to a card-column format. (Applies to mrPunchDsc only)

serialFullName
string or null

The fullname of the variable that holds the serial number of the respondent (Applies to mrPunchDsc only)

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Export the metadata and case data for a project

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Request Body schema: application/json

The description of the data to be exported

One of
format
string or null

The output format for the exported data, specified as a CDSC name (e.g. mrDataFileDsc)

fileType
string or null

The specific output file type for the CDSC in case the CDSC supports multiple file types (e.g. ddf)

ExportDataRequestOptions (string)

Options for the export that are not specific to the output format (e.g. none)

VariableTypes (string)

The variable types that should be included in the exported data (e.g. all)

SystemVariableCategory (string)

The category of system variables to include in the export (e.g. all)

RecordType (string)

The record type filter: Respondent, Test, or All (e.g. all)

DataCollectionStatuses (string)

The DataCollection.Status filter to apply (e.g. all)

selectedPresetFilter
string or null

The name of a predefined filter that should be applied (e.g. Yesterday)

filterExpression
string or null

The custom mrEvaluate filter expression to apply to the case data

startDateTime
string or null <date-time>

The date which cases have to be collected after to get export. If Null then no restriction is applied.

endDateTime
string or null <date-time>

The date which cases have to be collected before to get export. If Null then no restriction is applied.

version
string or null

The metadata version to export. If this is not specified the "DefaultVersion" setting for the DPM application will be used. If that is not set then the superversion, {..}, will be export

language
string or null

The metadata language to export. This sets the base and current langauge of the output MDD. It may also affect the language of the data exported depending on the export format. Defaults to the Accept-Language query parameter. If that does not exist then current langauge of the input metadata is used (e.g. en-US)

context
string or null

The metadata context to export. If this is not specified the "DefaultContext" setting for the DPM application will be used. If that is not set then the "Analysis" context will be used.

labelType
string or null

The metadata label type to export.

inputCustomProperties
string or null

Custom data link properties ("MR Init Custom") for the input data source

outputCustomProperties
string or null

Custom data link properties ("MR Init Custom") for the output data source

TimeZoneLocalization (string)

Controls the generation and localisation of the DataCollection_StartTime_Exported / DataCollection_FinishTime_Exported columns which localise the DataCollection.StartTime / DataCollection.FinishTime (e.g. none)

customTimeZone
string or null

The time zone for the DataCollection_StartTime_Exported / DataCollection_FinishTime_Exported columns if TimeZoneLocalization is set to Custom

useCategoryNames
boolean

If True then category names will export instead of category values, if this is applicable to the output format. Default is False. (Applies to "Delimited Text File" only)

useSavShortNames
boolean

If True then short names will be used when exporting to SAV files. (Applies to mrSavDsc only)

clearCardColAllocations
boolean

If True and the data source has card/column allocations (for mrPunchDsc) then these are cleared during the export. Default is False. (Only applies to mrPunchDsc and only if the input has existing mrPunchDsc data)

widthOfSerialNumber
integer <int32>

The width of the serial number if the export is to a card-column format. (Applies to mrPunchDsc only)

widthOfCardNumber
integer <int32>

The width of the card number if the export is to a card-column format. (Applies to mrPunchDsc only)

maxCardLength
integer <int32>

The max length of a card if the export is to a card-column format. (Applies to mrPunchDsc only)

serialFullName
string or null

The fullname of the variable that holds the serial number of the respondent (Applies to mrPunchDsc only)

Responses

Request samples

Content type
application/json
{
  • "format": "string",
  • "fileType": "string",
  • "options": "none",
  • "variableTypes": "none",
  • "systemVariables": "none",
  • "recordTypeFilter": "respondentData",
  • "dataCollectionStatusFilter": "none",
  • "selectedPresetFilter": "string",
  • "filterExpression": "string",
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "language": "string",
  • "context": "string",
  • "labelType": "string",
  • "inputCustomProperties": "string",
  • "outputCustomProperties": "string",
  • "timeZoneLocalization": "none",
  • "customTimeZone": "string",
  • "useCategoryNames": true,
  • "useSavShortNames": true,
  • "clearCardColAllocations": true,
  • "widthOfSerialNumber": 0,
  • "widthOfCardNumber": 0,
  • "maxCardLength": 0,
  • "serialFullName": "string"
}

ExportData.Filters

Retrieve all predefined filters

The Web API predefined filters are specific to the Web API and are independent of any predefined filters that might be configured via the Interview Server Administration Export Data activity.

Authorizations:
openIdConnect
header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a new filter

The Web API predefined filters are specific to the Web API and are independent of any predefined filters that might be configured via the Interview Server Administration Export Data activity.

Authorizations:
openIdConnect
header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Request Body schema: application/json

The filter to add

One of
name
required
string [ 1 .. 100 ] characters

The name of the filter

expression
required
string [ 1 .. 4000 ] characters

The mrEvaluate filter expression

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "expression": "string"
}

Retrieve a single named predefined filter

The Web API predefined filters are specific to the Web API and are independent of any predefined filters that might be configured via the Interview Server Administration Export Data activity.

Authorizations:
openIdConnect
path Parameters
filterName
required
string or null
Example: LastMonth

The name of the filter to retrieve

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "expression": "string"
}

Remove a predefined filter

The Web API predefined filters are specific to the Web API and are independent of any predefined filters that might be configured via the Interview Server Administration Export Data activity.

Authorizations:
openIdConnect
path Parameters
filterName
required
string or null

The name of the filter to remove

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Add or update a filter

The Web API predefined filters are specific to the Web API and are independent of any predefined filters that might be configured via the Interview Server Administration Export Data activity.

Authorizations:
openIdConnect
path Parameters
filterName
required
string or null
Example: LastMonth

The name of the filter to update

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Request Body schema: application/json

The new filter

One of
name
required
string [ 1 .. 100 ] characters

The name of the filter

expression
required
string [ 1 .. 4000 ] characters

The mrEvaluate filter expression

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "expression": "string"
}

ExportData.Formats

The available formats that data can be exported to.

Authorizations:
openIdConnect
header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Files

Deletes the specified file or folder from the User project folder

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

query Parameters
path
string or null

The path to the file or folder to delete

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Retrieve a directory listing, retrieve a file, or perform an action on the file or directory.

This endpoint performs multiple functions depending on if the path refers to a file or a directory.

If the path is not specified or if it is a directory then the default action is to return a directory listing. If the action is "Download" then it will instead return a ZIP file containing that directory. In that case the "Files" parameter can be used to specify a restricted list of individual files or sub-directories within the specified directory.

If the path is a file the default action is to return that file. Additional actions possible on a file are;

  • CheckIn - Check the file into the Shared project folder.
  • CheckOut - Check out of the file from the Shared project folder into the User project folder.
  • UndoCheckout - Undo a checkout by removing the local copy of the file from the User project folder.
Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

query Parameters
path
string or null

The file or path to process

action
string or null

The action to take on the specified both

files
string or null

A list of files separated by the | character

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Upload one or more files to the specified path

Newly uploaded files will initially be in a checked-out state. The file contents should be included in the request body.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

query Parameters
path
string or null

The path to upload the files to

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Request Body schema: multipart/form-data
file
Array of strings <binary>

Responses

Creates a new directory or empty file or uploads a file

If the request body contains any data then the "type" is assumed to be "file" otherwise it is assumed to be "directory", otherwise the type will be taken from the "type" parameter if it is specified.

If the type is "directory" then the directory specified by the path parameter will be created.

If the type is "file" then a file will be created in the directory specified by the "path" parameter. If there is any request body this will be used when creating the file, otherwise an empty file will be created.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

query Parameters
path
string or null

The path to the new directory or file

type
string or null

"File" or "Directory"

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Request Body schema: application/octet-stream
string <binary>

Responses

InterviewingReports.Filters

Retrieve the list of predefined record type filters (this list can not be modified)

Authorizations:
openIdConnect
header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Retrieves a single predefined record type filter

Authorizations:
openIdConnect
path Parameters
filterName
required
string or null
Example: Real

The name of the required record type filter

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "expression": "string"
}

Retrieve a list of all predefined Participant filters

The response is a list of the filter name and the filter expression. The filter name is not localized. The Participant filters can be customized per user. For a new user the Participant filters will default to those set in DPM in /Site/Properties/mrInterviewReportFilter/SampleFilters.If that DPM property is not defined a default set of filters will be used.

Authorizations:
openIdConnect
header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Add a new predefined Participant filter

Authorizations:
openIdConnect
header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Request Body schema: application/json

The new filter

One of
name
required
string [ 1 .. 100 ] characters

The name of the filter

expression
required
string [ 1 .. 4000 ] characters

The mrEvaluate filter expression

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "expression": "string"
}

Retrieves a single Participant filter

Authorizations:
openIdConnect
path Parameters
filterName
required
string or null

The name of the required predefined Participant filter

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "expression": "string"
}

Delete a predefined Participant filter

Authorizations:
openIdConnect
path Parameters
filterName
required
string or null
Example: QueueIsFresh

The name of the Participant filter to delete

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Add or update a predefined Participant filter

Name and Expression must be specified for the filter. The expression must be a valid mrEvaluate expression.

Authorizations:
openIdConnect
path Parameters
filterName
required
string or null

The name of the Participant filter to add or update

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Request Body schema: application/json

The new filter

One of
name
required
string [ 1 .. 100 ] characters

The name of the filter

expression
required
string [ 1 .. 4000 ] characters

The mrEvaluate filter expression

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "expression": "string"
}

Retrieve a list of all predefined Time Period filters

The response is a list of the filter name and the filter expression. The filter name is not localized. The period filters can be customized per user using the Interviewing Reports ISA activity. For a new user the period filters will default to those set in DPM in /Site/Properties/mrInterviewReportFilter. If that DPM property is not defined a default set of filters will be used.

Authorizations:
openIdConnect
header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Add a new predefined Time Period filter

Authorizations:
openIdConnect
header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Request Body schema: application/json

The new filter

One of
name
required
string [ 1 .. 100 ] characters

The name of the filter

expression
required
string [ 1 .. 4000 ] characters

The mrEvaluate filter expression

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "expression": "string"
}

Retrieves a single Time Period filter

Authorizations:
openIdConnect
path Parameters
filterName
required
string or null
Example: TodayServer

The name of the required predefined Time Period filter

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
null

Delete a predefined Time Period filter

Authorizations:
openIdConnect
path Parameters
filterName
required
string or null

The name of the Time Period filter to delete

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Add or update a predefined Time Period filter

A Name and Expression must be specified for the filter. The expression must be a valid mrEvaluate expression.

Authorizations:
openIdConnect
path Parameters
filterName
required
string or null

The name of the Time Period filter to add or update

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Request Body schema: application/json

The new filter

One of
name
required
string [ 1 .. 100 ] characters

The name of the filter

expression
required
string [ 1 .. 4000 ] characters

The mrEvaluate filter expression

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "expression": "string"
}

InterviewingReports.PerProject

Retrieve the fields that can be used with the "ReviewCalls" (IsCrossTab=True) report

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
[
  • "string"
]

Retrieve a list of reports applicable to the project

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Generate a report

The report can be optionally filtered by record type, participant or case data (depending on the report type), and time period. The output can either by in CSV or HTML format with optional charts. The status of the report is returned as a response header. If just this status is required that can be retrieved using the /Reports/{reportName}/Status endpoint.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

reportName
required
string or null
Example: SampleUsage

The report name

query Parameters
language
string or null

The language to use for labels in the report

recordTypeFilter
string or null

The predefined record type filter to apply (if applicable and required)

participantFilter
string or null

The predefined participant filter to apply (if applicable and required)

timePeriodFilter
string or null

The predefined time period filter to apply (if applicable and required)

timePeriodStart
string or null <date-time>

A custom "start" time restriction to apply to the report

timePeriodEnd
string or null <date-time>

A custom "end" time restriction to apply to the report

chartType
string or null

The name of the chart to generate for the report (if applicable and required)

bodyOnly
boolean or null

If true the output HTML only includes the HTML body tag and omits the head tag with the styles

style
string or null

The name of the style to use for HTML reports

format
string or null

The output format of the report (HTML or CSV). The default is HTML.

param1
string or null

The 1st parameter for any report that requires additional parameters

param2
string or null

The 2nd parameter for any report that requires additional parameters

param3
string or null

The 3rd parameter for any report that requires additional parameters

param4
string or null

The 4th parameter for any report that requires additional parameters

param5
string or null

The 5th parameter for any report that requires additional parameters

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Retrieve the chart renderer dependencies for any chart that may be in the report.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

reportName
required
string or null
Example: SampleUsage

The report name

chartRendererPath
required
string or null
Example: chart-renderer-entry.js

The path to the dependency

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Retrieve only the status of a report

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

reportName
required
string or null
Example: SampleUsage

The report name

query Parameters
language
string or null

The language to use for labels in the report

recordTypeFilter
string or null

The predefined record type filter to apply (if applicable and required)

participantFilter
string or null

The predefined participant filter to apply (if applicable and required)

timePeriodFilter
string or null

The predefined time period filter to apply (if applicable and required)

timePeriodStart
string or null <date-time>

A custom "start" time restriction to apply to the report

timePeriodEnd
string or null <date-time>

A custom "end" time restriction to apply to the report

chartType
string or null

The name of the chart to generate for the report (if applicable and required)

bodyOnly
boolean or null

If true the output HTML only includes the HTML body tag and omits the head tag with the styles

style
string or null

The name of the style to use for HTML reports

format
string or null

The output format of the report (HTML or CSV). The default is HTML.

param1
string or null

The 1st parameter for any report that requires additional parameters

param2
string or null

The 2nd parameter for any report that requires additional parameters

param3
string or null

The 3rd parameter for any report that requires additional parameters

param4
string or null

The 4th parameter for any report that requires additional parameters

param5
string or null

The 5th parameter for any report that requires additional parameters

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Metadata

Retrieve a summary of the contents of the metadata document

Returns the Versions, Routings, LCLs (Languages/Contexts/LabelTypes), and Properties that exist in the metadata at the specified location. This information is obtained without fully loading the metadata into memory. The list of available LCLs can then be used with the "Questions" URL to obtain labels for the specified LCLs.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

locationName
required
string or null
Example: Shared

The metadata location

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "versions": [
    ],
  • "languages": {
    },
  • "contexts": {
    },
  • "labelTypes": {
    },
  • "routings": {
    },
  • "properties": [
    ]
}

Retrieve the labels for all questions

By default the labels of the default LCL are returned but a specific LCL can be selected by specifying Language, Context, and LabelType query parameters. Multiple LCLs can be requested simultaneously by using comma separated lists of languages, contexts, and label types.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

locationName
required
string or null
Example: Shared

The location of the metadata

query Parameters
language
string or null
Example: language=en-US

The language name or comma separated list of language names

context
string or null
Example: context=Question

The context name or comma separated list of context names

labelType
string or null
Example: labelType=Label

The label type or comma separated list of label types

customPropertiesContext
string or null

The context name, or comma separated list of context names, for the retrieval of custom properties

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Retrieve the labels for all pages

By default the labels of the default LCL are returned but a specific LCL can be selected by specifying Language, Context, and LabelType query parameters.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

locationName
required
string or null
Example: Shared

The location of the metadata

query Parameters
language
string or null
Example: language=en-US

The language name or comma separated list of language names

context
string or null
Example: context=Question

The context name or comma separated list of context names

labelType
string or null
Example: labelType=Label

The label type or comma separated list of label types

customPropertiesContext
string or null

The context name, or comma separated list of context names, for the retrieval of custom properties

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

The full names of all questions in the metadata

Knowing the names of all the questions it is possible to retrieve the definition of individual questions separately as required.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

locationName
required
string or null
Example: Shared

The location of the metadata

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
[
  • "string"
]

The names of all pages in the metadata

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

locationName
required
string or null
Example: Shared

The location of the metadata

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
[
  • "string"
]

Retrieve all the pages within the metadata

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

locationName
required
string or null
Example: Shared

The metadata location

query Parameters
language
string or null
Example: language=en-US

The language name or comma separated list of language names

context
string or null
Example: context=Question

The context name or comma separated list of context names

labelType
string or null
Example: labelType=Label

The label type or comma separated list of label types

customPropertiesContext
string or null

The context name, or comma separated list of context names, for the retrieval of custom properties

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "lcLs": [
    ],
  • "pages": [
    ]
}

Retrieve a single page

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

locationName
required
string or null
Example: Shared

The metadata location

pageName
required
string or null

The name of the page to retrieve the metadata for

query Parameters
language
string or null
Example: language=en-US

The language name or comma separated list of language names

context
string or null
Example: context=Question

The context name or comma separated list of context names

labelType
string or null
Example: labelType=Label

The label type or comma separated list of label types

customPropertiesContext
string or null

The context name, or comma separated list of context names, for the retrieval of custom properties

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "lcLs": [
    ],
  • "page": {
    }
}

Retrieve all questions within the metadata

This is a simplified/flattened view of the questions of the metadata, i.e. category lists have been expanded and label alternative rules have been applied. By default the questions only contain labels for the default LCL but one or more LCLs can be specified using "Language", "Context", and "LabelType" query parameters which contain a comma separated list of the desired LCLs.The lists of available LCLs can be obtained from the "Contents" URL.

If only a single LCL is requested then questions and categories within the response will have a Label property, but if there are multiple LCLs they will have a Labels collection. That Labels collection will only contain labels that have been configured, i.e. if no label has been set for LCL with Id 4 then it will not appear in the list of labels.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

locationName
required
string or null
Example: Shared

The metadata location

query Parameters
language
string or null
Example: language=en-US

The language name or comma separated list of language names

context
string or null
Example: context=Question

The context name or comma separated list of context names

labelType
string or null
Example: labelType=Label

The label type or comma separated list of label types

customPropertiesContext
string or null

The context name, or comma separated list of context names, for the retrieval of custom properties

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "lcLs": [
    ],
  • "questions": [
    ]
}

Retrieve a single question

The question is specified using the question full-name which can be obtained from the QuestionNames URL. By default only the labels for the default LCL will be returned but labels for multiple LCLs can be requested by specifying the LCLs required.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

locationName
required
string or null
Example: Shared

The metadata location

questionName
required
string or null

The name of the question to retrieve the metadata for

query Parameters
language
string or null
Example: language=en-US

The language name or comma separated list of language names

context
string or null
Example: context=Question

The context name or comma separated list of context names

labelType
string or null
Example: labelType=Label

The label type or comma separated list of label types

customPropertiesContext
string or null

The context name, or comma separated list of context names, for the retrieval of custom properties

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "lcLs": [
    ],
  • "question": {
    }
}

Retrieve the locations in which metadata exists

The locations that metadata can exist in is a subset of {Master, Shared, User}.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
[
  • "string"
]

Metadata.CategoryMap

Retrieve the mapping of category value to category name

This endpoint useful for use with the CaseData Web API which for efficiency only returns the category values.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

locationName
required
string or null
Example: Shared

The metadata location

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Retrieve the mapping of category name to category value

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

locationName
required
string or null
Example: Shared

The metadata location

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "property1": 0,
  • "property2": 0
}

Participants.Download

Retrieve the results of a query of the Participant data as a CSV file with the mrOleDb SQL query as a query parameter.

If no query is specified then all fields and cases are returned. The table name for the participant data is always VDATA independent of the actual table name in SQL Server. This is to restrict the user to data they have been authorized for.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project to query

query Parameters
sql
string or null
Example: sql=SELECT * FROM VDATA

The mrOleDb SQL query to run to select the required fields and rows

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Retrieve the results of a query of the Participant data as a CSV file with the mrOleDb SQL query as the request body.

If no query is specified then all fields and cases are returned. The table name for the participant data is always VDATA independent of the actual table name in SQL Server. This is to restrict the user to data they have been authorized for.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project to query

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Request Body schema: application/json

The mrOleDb SQL query to run to select the required fields and rows

string or null

Responses

Request samples

Content type
application/json
"SELECT * FROM VDATA"

Participants.Query

Retrieve the results of the Participant data query as a single response

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project to query

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Request Body schema: application/json

The mrOleDb SQL query to execute

string or null

Responses

Request samples

Content type
application/json
"SELECT * FROM VDATA"

Response samples

Content type
application/json
{
  • "columns": {
    },
  • "rows": [
    ]
}

Retrieve the results of the case data query as a single response

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project to query

query Parameters
sql
required
string or null
Example: sql=SELECT * FROM VDATA

The mrOleDb SQL query to execute

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "columns": {
    },
  • "rows": [
    ]
}

Retrieve the queries that are currently active for the current user

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Execute a new query

Once a query has been created the allocated "id" and the column names for the result set will be returned. The rows of the result set can be retrieved in pages by repeatily posting "Next" until there are no more rows to retrieve.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Request Body schema: application/json

The mrOleDb SQL query

One of
sql
required
string non-empty

An mrOleDb SQL query or statement

userName
string or null

The name of the user that created the query

pageSize
integer or null <int32>

The number of rows to be returned in each response

expiryTime
integer or null <int32>

The UTC time when the query will expiry due to inactivity and will be closed.

Responses

Request samples

Content type
application/json
{
  • "SQL": "SELECT * FROM VDATA",
  • "UserName": "DPMAdmin",
  • "PageSize": 200
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "sql": "string",
  • "expiryTime": "2019-08-24T14:15:22Z",
  • "pageSize": 0,
  • "columns": {
    }
}

Retrieve the details of an active query.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

queryId
required
string or null
Example: a91d14ff-6f53-4be6-ba10-62a7a5b14123

The id of the active query

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "sql": "string",
  • "expiryTime": "2019-08-24T14:15:22Z",
  • "pageSize": 0,
  • "columns": {
    }
}

Delete a query that is no longer required without retrieving all rows in the result set.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

queryId
required
string or null
Example: a91d14ff-6f53-4be6-ba10-62a7a5b14123

The id of an active query

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Retrieves the next set of rows in the result set

If the response contain the last set of rows in the result set then the query is automatically deleted and a 204 "No Content" response is set. If the client is not going to retrieve all rows of the result set then the query should be terminated by deleting the query id in order to release the server resources associated with the query.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

queryId
required
string or null
Example: a91d14ff-6f53-4be6-ba10-62a7a5b14123

The id of an active query

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a summary of the Participants data

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "columns": {
    },
  • "rows": [
    ]
}

Participants.Schema

Retrieve details of VDATA with the Participant data (this will always be VDATA only)

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota
header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "columns": {
    },
  • "rows": [
    ]
}

Retrieve details of the columns within Participant table

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "columns": {
    },
  • "rows": [
    ]
}

Retrieve details of the data types used within the Participant data

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "columns": {
    },
  • "rows": [
    ]
}

Participants.Statement

Execute a statement that is not expected to produce a result set (e.g. UPDATE, INSERT, or DELETE)

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Request Body schema: application/json

The mrOleDb SQL statement to execute

string or null

Responses

Request samples

Content type
application/json
"UPDATE VDATA SET Queue = 'FRESH' WHERE Id = 'ID1'"

Response samples

Content type
application/json
0
0

Participants.Upload

Upload new Participant data in CSV format

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The name of the project

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Request Body schema: text/csv
string <binary>

Responses

Quotas.SingleQuota

Retrieves a single quota cell, including the definition of the cell and the target and completion counts.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

groupName
required
string or null

The group name

quotaNameOrId
required
string or null

The name or id of the quota cell (as a string)

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "groupName": "string",
  • "fullName": "string",
  • "type": "table",
  • "expression": "string",
  • "priority": "string",
  • "allowOverQuota": true,
  • "isCounterOnly": true,
  • "pending": 0,
  • "pendingExpression": "string",
  • "completed": 0,
  • "completedExpression": "string",
  • "target": 0,
  • "targetExpression": "string"
}

Updtes a single quota cell

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

groupName
required
string or null

The group name

quotaNameOrId
required
string or null

The name or id of the quota cell (as a string)

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Request Body schema: application/json

The attribute of the quota to be updated

One of
id
integer or null <int32>

The unique id of the quota cell within the project (read only)

name
string or null

The name of the quota cell within the quota group (read only)

groupName
string or null

The name of the group the quota cell is within (read only)

fullName
string or null

The full name of the quota cell (combined group name and cell name) (read only)

(QuotaType (string or null))

The type of the group that the cell is part of (read only)

expression
string or null

The mrEvaluate expression used to determine if the response is applicable to the quota cell (read only)

priority
string or null

The priority (as a double value) for the quota cell if the Priority PendMode is used (read/write)

allowOverQuota
boolean or null

True if the quota is allowed to possibly exceed the target count (read/write)

isCounterOnly
boolean or null

True if the quota is only a counter and there is no target (read/write)

pending
integer or null <int32>

The count of pending respondents for the quota cell (read/write)

pendingExpression
string or null

An mrEvaluate expression used to update the quota pend count (write-only)

completed
integer or null <int32>

The count of completed respondents for the quota cell (read/write)

completedExpression
string or null

An mrEvaluate expression used to update the quota completed count (write-only)

target
integer or null <int32>

The target completed count for the quota cell (read/write)

targetExpression
string or null

An mrEvaluate expression used to update the quota target count (write-only)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "groupName": "string",
  • "fullName": "string",
  • "type": "table",
  • "expression": "string",
  • "priority": "string",
  • "allowOverQuota": true,
  • "isCounterOnly": true,
  • "pending": 0,
  • "pendingExpression": "string",
  • "completed": 0,
  • "completedExpression": "string",
  • "target": 0,
  • "targetExpression": "string"
}

Quota.Group

Retrieves the details of a quota group and summary of the quotas in the group

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

groupName
required
string or null

The group name

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Response samples

Content type
application/json
{
  • "totalCompleted": 0,
  • "totalPending": 0,
  • "totalToTarget": 0,
  • "totalTarget": 0,
  • "quotas": [
    ],
  • "id": 0,
  • "name": "string",
  • "groupName": "string",
  • "fullName": "string",
  • "type": "table",
  • "expression": "string",
  • "priority": "string",
  • "allowOverQuota": true,
  • "isCounterOnly": true,
  • "pending": 0,
  • "pendingExpression": "string",
  • "completed": 0,
  • "completedExpression": "string",
  • "target": 0,
  • "targetExpression": "string",
  • "version": 0,
  • "pendMode": "normal",
  • "pendLimit": 0
}

Updates attributes of quota group or quotas within the group

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

groupName
required
string or null

The group name

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Request Body schema: application/json

The attributes of the group or list of quotas to update

One of
totalCompleted
integer or null <int32>

The total number of completed quotas across all cells

totalPending
integer or null <int32>

The total number of pending quotas across all cells

totalToTarget
integer or null <int32>

The number of completed quotas across all cells plus the total number of pending quotas for cells that have AllowOverQuota set to True.

totalTarget
integer or null <int32>

The total target across all cells

Array of objects or null (Quota)

The Quota cells

id
integer or null <int32>

The unique id of the quota cell within the project (read only)

name
string or null

The name of the quota cell within the quota group (read only)

groupName
string or null

The name of the group the quota cell is within (read only)

fullName
string or null

The full name of the quota cell (combined group name and cell name) (read only)

(QuotaType (string or null))

The type of the group that the cell is part of (read only)

expression
string or null

The mrEvaluate expression used to determine if the response is applicable to the quota cell (read only)

priority
string or null

The priority (as a double value) for the quota cell if the Priority PendMode is used (read/write)

allowOverQuota
boolean or null

True if the quota is allowed to possibly exceed the target count (read/write)

isCounterOnly
boolean or null

True if the quota is only a counter and there is no target (read/write)

pending
integer or null <int32>

The count of pending respondents for the quota cell (read/write)

pendingExpression
string or null

An mrEvaluate expression used to update the quota pend count (write-only)

completed
integer or null <int32>

The count of completed respondents for the quota cell (read/write)

completedExpression
string or null

An mrEvaluate expression used to update the quota completed count (write-only)

target
integer or null <int32>

The target completed count for the quota cell (read/write)

targetExpression
string or null

An mrEvaluate expression used to update the quota target count (write-only)

version
integer or null <int32>

The version sequence number for the quota group. This is incremented if the quota group or if any of the quotas in the group are modified.

(PendMode (string or null))

Determines how the quotas within the group are pended.

pendLimit
integer or null <int32>

The number of cells to pend within the group

Responses

Request samples

Content type
application/json
{
  • "totalCompleted": 0,
  • "totalPending": 0,
  • "totalToTarget": 0,
  • "totalTarget": 0,
  • "quotas": [
    ],
  • "id": 0,
  • "name": "string",
  • "groupName": "string",
  • "fullName": "string",
  • "type": "table",
  • "expression": "string",
  • "priority": "string",
  • "allowOverQuota": true,
  • "isCounterOnly": true,
  • "pending": 0,
  • "pendingExpression": "string",
  • "completed": 0,
  • "completedExpression": "string",
  • "target": 0,
  • "targetExpression": "string",
  • "version": 0,
  • "pendMode": "normal",
  • "pendLimit": 0
}

Quota

Summary of the quota cells for the project

Retrieves the completion status of the quotas for the project (sum of completes across all quota cells vs sum of targets across all qouta cells)

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Response samples

Content type
application/json
{
  • "totalCompleted": 0,
  • "totalPending": 0,
  • "totalToTarget": 0,
  • "totalTarget": 0
}

Update specified quota cells of the project

The quota cells in the supplied list must uniquely identity the cell within the project, either by full name or id.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

Project name

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Request Body schema: application/json

List of quota cells to update

One of
id
integer or null <int32>

The unique id of the quota cell within the project (read only)

name
string or null

The name of the quota cell within the quota group (read only)

groupName
string or null

The name of the group the quota cell is within (read only)

fullName
string or null

The full name of the quota cell (combined group name and cell name) (read only)

(QuotaType (string or null))

The type of the group that the cell is part of (read only)

expression
string or null

The mrEvaluate expression used to determine if the response is applicable to the quota cell (read only)

priority
string or null

The priority (as a double value) for the quota cell if the Priority PendMode is used (read/write)

allowOverQuota
boolean or null

True if the quota is allowed to possibly exceed the target count (read/write)

isCounterOnly
boolean or null

True if the quota is only a counter and there is no target (read/write)

pending
integer or null <int32>

The count of pending respondents for the quota cell (read/write)

pendingExpression
string or null

An mrEvaluate expression used to update the quota pend count (write-only)

completed
integer or null <int32>

The count of completed respondents for the quota cell (read/write)

completedExpression
string or null

An mrEvaluate expression used to update the quota completed count (write-only)

target
integer or null <int32>

The target completed count for the quota cell (read/write)

targetExpression
string or null

An mrEvaluate expression used to update the quota target count (write-only)

totalCompleted
integer or null <int32>

The total number of completed quotas across all cells

totalPending
integer or null <int32>

The total number of pending quotas across all cells

totalToTarget
integer or null <int32>

The number of completed quotas across all cells plus the total number of pending quotas for cells that have AllowOverQuota set to True.

totalTarget
integer or null <int32>

The total target across all cells

Array of objects or null (Quota)

The Quota cells

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "groupName": "string",
  • "fullName": "string",
  • "type": "table",
  • "expression": "string",
  • "priority": "string",
  • "allowOverQuota": true,
  • "isCounterOnly": true,
  • "pending": 0,
  • "pendingExpression": "string",
  • "completed": 0,
  • "completedExpression": "string",
  • "target": 0,
  • "targetExpression": "string",
  • "totalCompleted": 0,
  • "totalPending": 0,
  • "totalToTarget": 0,
  • "totalTarget": 0,
  • "quotas": [
    ]
}

Quota.Groups

Retrieve all quota groups and their details.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Response samples

Content type
application/json
{
  • "Capacity": 0,
  • "Count": 0,
  • "Item": {
    }
}

Update the quotas of specific quota groups

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Request Body schema: application/json

List of quota groups and their attribute or quotas to be updated

One of
Capacity
integer <int32>
Count
integer <int32>
(QuotaGroup (object or null))

Responses

Request samples

Content type
application/json
{
  • "Capacity": 0,
  • "Count": 0,
  • "Item": {
    }
}

Quota.GroupQuotas

Get the details of all quotas within a quota group

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

groupName
required
string or null

The quota group name

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Response samples

Content type
application/json
{
  • "totalCompleted": 0,
  • "totalPending": 0,
  • "totalToTarget": 0,
  • "totalTarget": 0,
  • "quotas": [
    ],
  • "id": 0,
  • "name": "string",
  • "groupName": "string",
  • "fullName": "string",
  • "type": "table",
  • "expression": "string",
  • "priority": "string",
  • "allowOverQuota": true,
  • "isCounterOnly": true,
  • "pending": 0,
  • "pendingExpression": "string",
  • "completed": 0,
  • "completedExpression": "string",
  • "target": 0,
  • "targetExpression": "string",
  • "version": 0,
  • "pendMode": "normal",
  • "pendLimit": 0
}

Updates specific quotas or all quotas within the quota group

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

groupName
required
string or null

The qouta group name

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Request Body schema: application/json

Attributes of the quota group, all quotas, or specific quotas that are to be updated

One of
totalCompleted
integer or null <int32>

The total number of completed quotas across all cells

totalPending
integer or null <int32>

The total number of pending quotas across all cells

totalToTarget
integer or null <int32>

The number of completed quotas across all cells plus the total number of pending quotas for cells that have AllowOverQuota set to True.

totalTarget
integer or null <int32>

The total target across all cells

Array of objects or null (Quota)

The Quota cells

id
integer or null <int32>

The unique id of the quota cell within the project (read only)

name
string or null

The name of the quota cell within the quota group (read only)

groupName
string or null

The name of the group the quota cell is within (read only)

fullName
string or null

The full name of the quota cell (combined group name and cell name) (read only)

(QuotaType (string or null))

The type of the group that the cell is part of (read only)

expression
string or null

The mrEvaluate expression used to determine if the response is applicable to the quota cell (read only)

priority
string or null

The priority (as a double value) for the quota cell if the Priority PendMode is used (read/write)

allowOverQuota
boolean or null

True if the quota is allowed to possibly exceed the target count (read/write)

isCounterOnly
boolean or null

True if the quota is only a counter and there is no target (read/write)

pending
integer or null <int32>

The count of pending respondents for the quota cell (read/write)

pendingExpression
string or null

An mrEvaluate expression used to update the quota pend count (write-only)

completed
integer or null <int32>

The count of completed respondents for the quota cell (read/write)

completedExpression
string or null

An mrEvaluate expression used to update the quota completed count (write-only)

target
integer or null <int32>

The target completed count for the quota cell (read/write)

targetExpression
string or null

An mrEvaluate expression used to update the quota target count (write-only)

version
integer or null <int32>

The version sequence number for the quota group. This is incremented if the quota group or if any of the quotas in the group are modified.

(PendMode (string or null))

Determines how the quotas within the group are pended.

pendLimit
integer or null <int32>

The number of cells to pend within the group

Responses

Request samples

Content type
application/json
{
  • "totalCompleted": 0,
  • "totalPending": 0,
  • "totalToTarget": 0,
  • "totalTarget": 0,
  • "quotas": [
    ],
  • "id": 0,
  • "name": "string",
  • "groupName": "string",
  • "fullName": "string",
  • "type": "table",
  • "expression": "string",
  • "priority": "string",
  • "allowOverQuota": true,
  • "isCounterOnly": true,
  • "pending": 0,
  • "pendingExpression": "string",
  • "completed": 0,
  • "completedExpression": "string",
  • "target": 0,
  • "targetExpression": "string",
  • "version": 0,
  • "pendMode": "normal",
  • "pendLimit": 0
}

Quota.All

Retrieve a list of all quotas with the project

Retrieves information about the quota cells, target counts, and the current pending and target counts for all quota cells in the project

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "groupName": "string",
  • "fullName": "string",
  • "type": "table",
  • "expression": "string",
  • "priority": "string",
  • "allowOverQuota": true,
  • "isCounterOnly": true,
  • "pending": 0,
  • "pendingExpression": "string",
  • "completed": 0,
  • "completedExpression": "string",
  • "target": 0,
  • "targetExpression": "string",
  • "totalCompleted": 0,
  • "totalPending": 0,
  • "totalToTarget": 0,
  • "totalTarget": 0,
  • "quotas": [
    ]
}

Update all or selected quotas with in the project

The quotas in the quota list must include an Id or FullName to uniquely identify the quota cell within the project.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Request Body schema: application/json

The quotas to update

One of
id
integer or null <int32>

The unique id of the quota cell within the project (read only)

name
string or null

The name of the quota cell within the quota group (read only)

groupName
string or null

The name of the group the quota cell is within (read only)

fullName
string or null

The full name of the quota cell (combined group name and cell name) (read only)

(QuotaType (string or null))

The type of the group that the cell is part of (read only)

expression
string or null

The mrEvaluate expression used to determine if the response is applicable to the quota cell (read only)

priority
string or null

The priority (as a double value) for the quota cell if the Priority PendMode is used (read/write)

allowOverQuota
boolean or null

True if the quota is allowed to possibly exceed the target count (read/write)

isCounterOnly
boolean or null

True if the quota is only a counter and there is no target (read/write)

pending
integer or null <int32>

The count of pending respondents for the quota cell (read/write)

pendingExpression
string or null

An mrEvaluate expression used to update the quota pend count (write-only)

completed
integer or null <int32>

The count of completed respondents for the quota cell (read/write)

completedExpression
string or null

An mrEvaluate expression used to update the quota completed count (write-only)

target
integer or null <int32>

The target completed count for the quota cell (read/write)

targetExpression
string or null

An mrEvaluate expression used to update the quota target count (write-only)

totalCompleted
integer or null <int32>

The total number of completed quotas across all cells

totalPending
integer or null <int32>

The total number of pending quotas across all cells

totalToTarget
integer or null <int32>

The number of completed quotas across all cells plus the total number of pending quotas for cells that have AllowOverQuota set to True.

totalTarget
integer or null <int32>

The total target across all cells

Array of objects or null (Quota)

The Quota cells

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "groupName": "string",
  • "fullName": "string",
  • "type": "table",
  • "expression": "string",
  • "priority": "string",
  • "allowOverQuota": true,
  • "isCounterOnly": true,
  • "pending": 0,
  • "pendingExpression": "string",
  • "completed": 0,
  • "completedExpression": "string",
  • "target": 0,
  • "targetExpression": "string",
  • "totalCompleted": 0,
  • "totalPending": 0,
  • "totalToTarget": 0,
  • "totalTarget": 0,
  • "quotas": [
    ]
}

Retrieve the details of a single quota cell within the project.

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

fullNameOrId
required
string or null

The full name or id (as a string) of the quota cell.

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "groupName": "string",
  • "fullName": "string",
  • "type": "table",
  • "expression": "string",
  • "priority": "string",
  • "allowOverQuota": true,
  • "isCounterOnly": true,
  • "pending": 0,
  • "pendingExpression": "string",
  • "completed": 0,
  • "completedExpression": "string",
  • "target": 0,
  • "targetExpression": "string"
}

Update a single quota cell within the project

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

fullNameOrId
required
string or null

The full name or id (as a string) of the quota cell.

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Request Body schema: application/json

The attributes of the quota cell to modify

One of
id
integer or null <int32>

The unique id of the quota cell within the project (read only)

name
string or null

The name of the quota cell within the quota group (read only)

groupName
string or null

The name of the group the quota cell is within (read only)

fullName
string or null

The full name of the quota cell (combined group name and cell name) (read only)

(QuotaType (string or null))

The type of the group that the cell is part of (read only)

expression
string or null

The mrEvaluate expression used to determine if the response is applicable to the quota cell (read only)

priority
string or null

The priority (as a double value) for the quota cell if the Priority PendMode is used (read/write)

allowOverQuota
boolean or null

True if the quota is allowed to possibly exceed the target count (read/write)

isCounterOnly
boolean or null

True if the quota is only a counter and there is no target (read/write)

pending
integer or null <int32>

The count of pending respondents for the quota cell (read/write)

pendingExpression
string or null

An mrEvaluate expression used to update the quota pend count (write-only)

completed
integer or null <int32>

The count of completed respondents for the quota cell (read/write)

completedExpression
string or null

An mrEvaluate expression used to update the quota completed count (write-only)

target
integer or null <int32>

The target completed count for the quota cell (read/write)

targetExpression
string or null

An mrEvaluate expression used to update the quota target count (write-only)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "groupName": "string",
  • "fullName": "string",
  • "type": "table",
  • "expression": "string",
  • "priority": "string",
  • "allowOverQuota": true,
  • "isCounterOnly": true,
  • "pending": 0,
  • "pendingExpression": "string",
  • "completed": 0,
  • "completedExpression": "string",
  • "target": 0,
  • "targetExpression": "string"
}

Quota.Table

The quotas of the named quota group represented as a table structure (read-only)

This endpoint is intended to be used by GUIs that will format the quota cells into a table for display. The retrieved quota cells are arranged as a table, either 1 or 2-dimensional depending on the definition of the quota cells.

Only table quotas can be retrieved, not expression based quotas

Authorizations:
openIdConnect
path Parameters
projectName
required
string or null
Example: MM1WithQuota

The project name

groupName
required
string or null

The quota group

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Response samples

Content type
application/json
{
  • "totalCompleted": 0,
  • "totalPending": 0,
  • "totalToTarget": 0,
  • "totalTarget": 0,
  • "pendMode": "normal",
  • "pendLimit": 0,
  • "sideAxes": [
    ],
  • "topAxes": [
    ],
  • "quotas": [
    ]
}

Core.Metrics

All application metrics that meet the optional filter criteria

Authorizations:
openIdConnect
query Parameters
filter
string or null

mrEvaluate filter expression. If not specified all metrics are returned

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

The metrics tag names and tag values that are currently in use

Authorizations:
openIdConnect
header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Current contexts for which metrics are available

Authorizations:
openIdConnect
header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Response samples

Content type
application/json
[
  • "string"
]

The metrics for a single context

Authorizations:
openIdConnect
path Parameters
contextName
required
string or null
Example: Application

The context name required

query Parameters
filter
string or null

An mrEvaluate filter expression to select metrics

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

The tag names and values in use by the named context

Authorizations:
openIdConnect
path Parameters
contextName
required
string or null
Example: HttpRequests

The context name required

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

All metrics formatted for ingest into Prometheus

Authorizations:
openIdConnect
query Parameters
contextName
string or null

The context name required (optional)

filter
string or null

An mrEvaluate filter expression to select metrics (optional)

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

All metrics that have been defined by the Web API can could potentially be returned if there is a value for that metric

If the client specifies an Accept header of "text/html" then response will be formatted as HTML. This should happen if /Metrics/Defined path is retrieved using a web browser.

Authorizations:
openIdConnect
header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Core.OpenApi

Retrieve the OpenApi v3 specificiation of the Web API

Authorizations:
openIdConnect
path Parameters
version
required
string or null
header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Core.Versions

Retrieves the version information of all components of the Web API

Authorizations:
openIdConnect
header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Retrieves the version information of a single component of the Web API.

Authorizations:
openIdConnect
path Parameters
assemblyName
required
string or null
Example: Intelligence.WebApi.Components.CaseData

The component name

header Parameters
X-Api-Version
required
string
Value: "1.1"

The component API version

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "apiVersion": "string",
  • "assemblyVersion": "string",
  • "fileVersion": "string"
}

InterviewingReports

The name of the styles that can be specified for a report

Authorizations:
openIdConnect
header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
[
  • "string"
]

Retrieve the CSS for the named style

Authorizations:
openIdConnect
path Parameters
styleName
required
string or null
Example: Compact

The name of the style to be retrieved

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

The chart types that are available

The response includes the chart type name and a label for display purposes.

Authorizations:
openIdConnect
header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

InterviewingReports.CrossProject

Retrieve a list of available cross-project reports based on the project types that exist

Authorizations:
openIdConnect
query Parameters
customerAccountId
string or null

The customer account id to restrict the projects included in the report.

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Generate a cross-project report

The status of the report is returned as a response header. If just this status is required that can be retrieved using the /Reports/{reportName}/Status endpoint.

Authorizations:
openIdConnect
path Parameters
reportName
required
string or null
Example: BusyWaitIdleCrossProject

The report name

query Parameters
language
string or null

The language to use for labels in the report

recordTypeFilter
string or null

The predefined record type filter to apply (if applicable and required)

participantFilter
string or null

The predefined participant filter to apply (if applicable and required)

timePeriodFilter
string or null

The predefined time period filter to apply (if applicable and required)

timePeriodStart
string or null <date-time>

A custom "start" time restriction to apply to the report

timePeriodEnd
string or null <date-time>

A custom "end" time restriction to apply to the report

chartType
string or null

The name of the chart to generate for the report (if applicable and required)

bodyOnly
boolean or null

If true the output HTML only includes the HTML body tag and omits the head tag with the styles

style
string or null

The name of the style to use for HTML reports

format
string or null

The output format of the report (HTML or CSV). The default is HTML.

param1
string or null

The 1st parameter for any report that requires additional parameters

param2
string or null

The 2nd parameter for any report that requires additional parameters

param3
string or null

The 3rd parameter for any report that requires additional parameters

param4
string or null

The 4th parameter for any report that requires additional parameters

param5
string or null

The 5th parameter for any report that requires additional parameters

customerAccountId
string or null

The customer account id to restrict the projects included in the report.

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Retrieve the chart renderer dependencies for any chart that may be in the report.

Authorizations:
openIdConnect
path Parameters
reportName
required
string or null
Example: BusyWaitIdleCrossProject

The report name

chartRendererPath
required
string or null
Example: chart-renderer-entry.js

The path to the dependency

query Parameters
projectName
required
string or null
Example: projectName=MM1WithQuota

The project name

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses

Retrieve only the status of a cross-project report

Authorizations:
openIdConnect
path Parameters
reportName
required
string or null
Example: BusyWaitIdleCrossProject

The report name

query Parameters
language
string or null

The language to use for labels in the report

recordTypeFilter
string or null

The predefined record type filter to apply (if applicable and required)

participantFilter
string or null

The predefined participant filter to apply (if applicable and required)

timePeriodFilter
string or null

The predefined time period filter to apply (if applicable and required)

timePeriodStart
string or null <date-time>

A custom "start" time restriction to apply to the report

timePeriodEnd
string or null <date-time>

A custom "end" time restriction to apply to the report

chartType
string or null

The name of the chart to generate for the report (if applicable and required)

bodyOnly
boolean or null

If true the output HTML only includes the HTML body tag and omits the head tag with the styles

style
string or null

The name of the style to use for HTML reports

format
string or null

The output format of the report (HTML or CSV). The default is HTML.

param1
string or null

The 1st parameter for any report that requires additional parameters

param2
string or null

The 2nd parameter for any report that requires additional parameters

param3
string or null

The 3rd parameter for any report that requires additional parameters

param4
string or null

The 4th parameter for any report that requires additional parameters

param5
string or null

The 5th parameter for any report that requires additional parameters

customerAccountId
string or null

The customer account id to restrict the projects included in the report.

header Parameters
X-Api-Version
required
string
Value: "1.0"

The component API version

Responses