REST API: Summary

Methods

getCompanySummary
getCategorySummary
getFolderSummary
getUserSummary
getTeamSummary
getSutSummary
getRequirementSummary
getSpecificationSummary
getTestSummary
getTestcaseSummary
getReusableTestcaseSummary
getTestcaseReferencingReusableTestcaseSummary
getCampaignSummary
getSessionSummary
getBugSummary
getAgentSummary
getSqlReportSummary
getAssetSummary

TypeVer.Command parameterParameters
Getters
GET4.0+ getCompanySummary companyId=<id>
Example of success:
GET4.0+ getCategorySummary categoryId=<id>
Example of success:
GET4.0+ getFolderSummary folderId=<id>
Example of success:
GET4.0b3+ getUserSummary userId=<id>
Example of success:
GET4.0b3+ getTeamSummary teamId=<id>
Example of success:
GET4.0+ getSutSummary sutId=<id>
Example of success:
GET4.0+ getRequirementSummary requirementId=<id>
(opt.) connectorIndex=<index>
Example of success:
GET4.0+ getSpecificationSummary specificationId=<id>
Example of success:
GET4.0+ getTestSummary testId=<id>
Example of success:
GET4.0+ getTestcaseSummary testcaseId=<id>
Example of success:
GET4.0+ getCampaignSummary campaignId=<id>
Example of success:
GET4.0+ getSessionSummary sessionId=<id>
Example of success:
GET4.0+ getBugSummary bugId=<id>
(opt.) connectorIndex=<index>
Example of success:
GET4.0sp1+ getAgentSummary agentId=<id>
Example of success:
GET4.1sp2+ getSqlReportSummary sqlReportId=<id>
Example of success:
GET5beta2+ getAssetSummary assetId=<id>
Example of success:

GET5beta2+ getReusableTestcaseSummary reusableTestcaseId=<id>
Example of success:

GET5beta2+ getTestcaseReferencingReusableTestcaseSummary testcaseId=<id>
Example of success:


Parameter types

Lists

List often indentifiable as <xxxIds> or <xxxNames> refer to comma-delimited strings.

id

<id> refers to an integer value refering to an item's id.

name

<name> refers to a string value refering to an item's name.

date

<date> refers to a string value representing a date. It must respect the format: YYY-MM-DD (i.e. '2020-12-24')

treeType

<treeType> refers to a short value refering to a tree: 
TREE_TYPE_USER      = 1
	TREE_TYPE_SUT       = 2
	TREE_TYPE_AGENT     = 3
	TREE_TYPE_REQ       = 4
	TREE_TYPE_SPEC      = 5
	TREE_TYPE_PROJECT   = 6
	TREE_TYPE_TEST      = 7
	TREE_TYPE_CAMPAIGN  = 8
	TREE_TYPE_DEFECT    = 9
	TREE_TYPE_DOCUMENT  = 10
	TREE_TYPE_SQLREPORT = 11
	TREE_TYPE_ASSET     = 12
	TREE_TYPE_RIGHT     = 15
	TREE_TYPE_CALENDAR  = 16
	TREE_TYPE_DASHBOARD = 17

rootFolderId

<rootFolderId> refers to a short value refering to the id of the root folder of each tree: 
PARENT_ROOT_FOLDER_ID_USER       = 1
	PARENT_ROOT_FOLDER_ID_SUT        = 2
	PARENT_ROOT_FOLDER_ID_REQ        = 3
	PARENT_ROOT_FOLDER_ID_SPEC       = 4
	PARENT_ROOT_FOLDER_ID_TEST       = 5
	PARENT_ROOT_FOLDER_ID_CAMPAIGN   = 6
	PARENT_ROOT_FOLDER_ID_DEFECT     = 7
	PARENT_ROOT_FOLDER_ID_AGENT      = 8
	PARENT_ROOT_FOLDER_ID_PROJECT    = 9
	PARENT_ROOT_FOLDER_ID_TASK       = 10
	PARENT_ROOT_FOLDER_ID_DOCUMENT   = 11
	PARENT_ROOT_FOLDER_ID_SQLREPORT  = 12
	PARENT_ROOT_FOLDER_ID_ASSET      = 13

nodeType

<nodeType> refers to a short value refering to the type of an item in the trees: 
	TYPE_NONE               = 0
	TYPE_ROOT               = 1
	TYPE_CATEGORY           = 2
	TYPE_FOLDER             = 3
	TYPE_REQUIREMENT        = 4
	TYPE_SPECIFICATION      = 5
	TYPE_TEST               = 6
	TYPE_TESTCASE           = 7
	TYPE_CAMPAIGN           = 8
	TYPE_CAMPAIGNSESSION    = 9
	TYPE_DEFECT             = 10
	TYPE_SUT                = 11
	TYPE_USER               = 12
	TYPE_COMPANY            = 13
	TYPE_REPORT             = 23
	TYPE_AGENT              = 24
	TYPE_SCHEDULE           = 25
	TYPE_PROJECT            = 26
	TYPE_TASK               = 27
	TYPE_SPRINT             = 28
	TYPE_PROJECTFOLDER      = 29
	TYPE_DOCUMENT           = 30
	TYPE_USERGROUP          = 33
	TYPE_SQLREPORT          = 34
	TYPE_EXPLORATORYSESSION = 35
	TYPE_ASSET              = 37
	TYPE_RTESTCASE          = 38
	TYPE_RSTEP              = 39
	TYPE_RCHECK             = 40
	TYPE_TESTCASE_RTESTCASE = 41
	TYPE_HOLIDAY            = 42
	TYPE_TRACK              = 43
	TYPE_TESTCASEEXECUTION  = 50

attributeType

<attributeType> refers to one of those strings: 
	"string",
	"integer",
	"boolean"

parameterType

<parameterType> refers to one of those strings: 
	"string",
	"integer",
	"boolean"

customFieldType

<customFieldType> refers to one of those strings: 
	"integer",
	"string",
	"boolean",
	"string_choice",
	"html,"

algorithm

<algorithm> refers to a short value refering to the algorithm used to create parameter combinations: 
	ALGO_PAIRWISE          = 1
	ALGO_ALL               = 2

result

<result> refers to a short value corresponding to a result: 
RESULT_NO_RESULT      = -1
	RESULT_NOT_EXECUTED   = 0
	RESULT_SUCCESS        = 1
	RESULT_FAILURE        = 2
	RESULT_INDEFINITE     = 3
	RESULT_NOT_EXECUTABLE = 4
	RESULT_UNKNOWN        = 6
	RESULT_INFO           = 8 // only for messages

rulesMask

<rulesMask> refers to a short value defining a set of rules: It can be the addition of one or several of the following rules. (you must add them to get only one single short value)
LATEST_RESULTS_NOT_SUCCESSFUL = 0x1; // same as F | U | NE | NA
	LATEST_RESULTS_SUCCESS        = 0x2;
	LATEST_RESULTS_FAILURE        = 0x4;
	LATEST_RESULTS_UNKNOWN        = 0x8;
	LATEST_RESULTS_NOT_EXECUTED   = 0x10;
	LATEST_RESULTS_NOT_EXECUTABLE = 0x20;
	FAILED_AT_LEAST_ONCE          = 0x40;
	UNKNOWN_AT_LEAST_ONCE         = 0x80;
	NEVER_BEEN_SUCCESSFUL         = 0x100;
	NEVER_BEEN_EXECUTED           = 0x200;

requirementStatus

<requirementStatus> refers to a short value refering to a requirement status: 
REQUIREMENT_STATUS_NEW          = 10
	REQUIREMENT_STATUS_ACKNOWLEDGED = 20
	REQUIREMENT_STATUS_APPROVED     = 30

specificationStatus

<specificationStatus> refers to a short value refering to a specification status: 
SPECIFICATION_STATUS_NEW           = 10
	SPECIFICATION_STATUS_ACKNOWLEDGED  = 20
	SPECIFICATION_STATUS_APPROVED      = 30

testStatus

<testStatus> refers to a short value refering to a test status: 
TEST_STATUS_NEW           = 10
	TEST_STATUS_ACKNOWLEDGED  = 20
	TEST_STATUS_APPROVED      = 30

sessionStatus

<sessionStatus> refers to a short value refering to a session status: 
SESSION_STATUS_NEW           = 10
	SESSION_STATUS_ACKNOWLEDGED  = 20
	SESSION_STATUS_APPROVED      = 30

bugStatus

<bugStatus> refers to a short value refering to a bug status: 
BUG_STATUS_NEW           = 10
	BUG_STATUS_ASSIGNED      = 20
	BUG_STATUS_ACKNOWLEDGED  = 30
	BUG_STATUS_RESOLVED      = 40
	BUG_STATUS_CLOSED        = 50

requirementPriority

<requirementPriority> refers to a short value refering to a requirement priority: 
REQUIREMENT_PRIORITY_HIGH   = 10
	REQUIREMENT_PRIORITY_NORMAL = 20
	REQUIREMENT_PRIORITY_LOW    = 30

specificationPriority

<specificationPriority> refers to a short value refering to a specification priority: 
SPECIFICATION_PRIORITY_HIGH   = 10
	SPECIFICATION_PRIORITY_NORMAL = 20
	SPECIFICATION_PRIORITY_LOW    = 30

testPriority

<testPriority> refers to a short value from 0 to 10 refering to a test priority:

bugPriority

<bugPriority> refers to a short value refering to a bug priority: 
BUG_PRIORITY_HIGH   = 10
		BUG_PRIORITY_NORMAL = 20
		BUG_PRIORITY_LOW    = 30

requirementType

<requirementType> refers to a string value refering to a requirement type localized (as it appears in the GUI in the language of the user used for authentication)

testType

<testType> refers to a string value refering to a test type localized (as it appears in the GUI in the language of the user used for authentication)

assetType

<assetType> refers to a string value refering to an asset type localized (as it appears in the GUI in the language of the user used for authentication)

severity

<severity> refers to a short value refering to a bug severity: 
BUG_SEVERITY_BLOCKING    = 10
	BUG_SEVERITY_MAJOR       = 20
	BUG_SEVERITY_MINOR       = 30
	BUG_SEVERITY_COSMETIC    = 40
	BUG_SEVERITY_ENHANCEMENT

freezeStatus

<freezeStatus> refers to a short value refering to a freez status: 
FREEZE_STATUS_NORMAL = 0
	FREEZE_STATUS_FROZEN = 1 (the item is frozen and not editable anymore)
	FREEZE_STATUS_SIGNED = 2 (the item has been signed and is not editable anymore)

sessionState

<sessionState> refers to a short value refering to a session state: 
THREAD_STATE_INITIALIZED = 1
	THREAD_STATE_RUNNING     = 2
	THREAD_STATE_PAUSED      = 3
	THREAD_STATE_TERMINATED  = 4
	THREAD_STATE_ARMED       = 5

importType

<importType> refers to a short value refering to the type of an import: 
	IMPORT_SUTS                                = 1
	IMPORT_REQUIREMENTS                        = 2
	IMPORT_SPECIFICATIONS                      = 3
	IMPORT_TESTS                               = 4
	IMPORT_BUGS                                = 5
	IMPORT_ASSETS                              = 6
	IMPORT_TERMS                               = 7
	IMPORT_LINKS_SUTS_REQUIREMENTS             = 10
	IMPORT_LINKS_REQUIREMENTS_SPECIFICATIONS   = 11
	IMPORT_LINKS_SPECIFICATIONS_TESTS          = 12
	IMPORT_LINKS_REQUIREMENTS_TESTS            = 13
	IMPORT_LINKS_REQUIREMENTS_REQUIREMENTS     = 14
	IMPORT_LINKS_SPECIFICATIONS_SPECIFICATIONS = 15
	IMPORT_QC_EXPORT_FILE                      = 20

importFormat

<importFormat> refers to a short value refering to the format of an import: 
	FORMAT_XLS = 1
	FORMAT_XML = 2

usage

<usage> refers to a short value refering to a risk's usage parameter: It can take a value in between 0 and 5.

complexity

<complexity> refers to a short value refering to a risk's complexity parameter: It can take a value in between 0 and 5.

maturity

<maturity> refers to a short value refering to a risk's maturity parameter: It can take a value in between 0 and 5.

impact

<impact> refers to a short value refering to a risk's impact parameter: It can take a value in between 0 and 5.

risk

<risk> refers to a short value refering to the total score of a risk: It can take a value in between 0 and 2500.

textToken

<textToken> refers to a string also refered as passphrase that the signer provide during signature.

blobToken

<blobToken> refers to the content of a file (i.e. a scanned signature) that the signer provide during signature.

moduleRight

<moduleRight> refers to a short value refering to the right to use a module (in the sidebar). See the actionRight section for the value of the constants.