Virima API Specification - ReportingClauseService Services

The requests documented in this section are directed to ReportingClauseService resources, which represent .

Contents

1 addReportClause POST Interface
2 getReportClause POST Interface

addReportClause POST Interface

Method: POST

Relative URL: reporting-clause/add

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
reportClauselis	ArrayOfReportClause

Response Structure:

Field Name	Type	Description
repClauseList	ArrayOfReportClause

Example Request:

ADDREPORTCLAUSE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "reportingClauseList":[
      {
         "reportId": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "semanticLayerItemId": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "parentClause": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "operator": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "clauseType":"?",
         "operand":"?",
         "value":"?",
         "value1":"?",
         "formula":"?",
         "formulaType":"?",
         "tableName":"?"
      }   ],
   "reportingDisplayList":[
      {
         "report": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "semanticItem": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "prefix":"?",
         "display":"?",
         "tableName":"?",
         "tabPrefix":"?",
         "possibleValues":"?",
         "type":"?",
         "colName":"?"
      }   ]
}

Example Response:

{
   "id":2147483647,
   "reportingClauseList":[
      {
         "id":2147483647,
         "reportId": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "semanticLayerItemId": {
               "id":2145246200,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "parentClause": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "operator": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "clauseType":"?",
         "operand":"?",
         "value":"?",
         "value1":"?",
         "formula":"?",
         "formulaType":"?",
         "tableName":"?"
      }   ],
   "reportingDisplayList":[
      {
         "id":803078041,
         "report": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "semanticItem": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "prefix":"?",
         "display":"?",
         "tableName":"?",
         "tabPrefix":"?",
         "possibleValues":"?",
         "type":"?",
         "colName":"?"
      }   ]
}

getReportClause POST Interface