Virima API Specification - ConfigurationServices Services

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

Contents

1 addProperty POST Interface
2 getAllProperties GET Interface
3 getAllGroupsName GET Interface
4 getAllOrder GET Interface

addProperty POST Interface

Method: POST

Relative URL: configuration/add-property

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
property	GroupProperty

Response Structure:

Field Name	Type	Description
properties	PropertyList

Example Request:

ADDPROPERTY 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "groupId":2147483647,
   "propertyName":"?",
   "propertyType":"?"
}

Example Response:

{
   "id":2147483647,
   "properties":[
      {
         "id":2147483647,
         "groupName":"?",
         "propertyName":"?",
         "columnName":"?",
         "dataType":"?",
         "defaultColumn":"?",
         "mandatory":"?"
      }   ]
}

getAllProperties GET Interface

Method: GET

Relative URL: configuration/get-all-properties

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
properties	PropertyList

Example Request:

Example Response:

{
   "id":2147483647,
   "properties":[
      {
         "id":94463540,
         "groupName":"?",
         "propertyName":"?",
         "columnName":"?",
         "dataType":"?",
         "defaultColumn":"?",
         "mandatory":"?"
      }   ]
}

getAllGroupsName GET Interface

Method: GET

Relative URL: configuration/get-all-groups-name

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
groupList	GroupList

Example Request:

Example Response:

{
   "id":2147483647,
   "groups":[
      {
         "id":2147483647,
         "groupName":"?",
         "groupOrder":?,
         "archive":?,
         "lastModifiedBy": {
               "id":594120367,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "id":99597849,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "lastModifiedOn":?,
         "createdOn":?,
         "defaultColumn":?,
         "uniqueId":"?"
      }   ]
}

getAllOrder GET Interface

Method: GET

Relative URL: configuration/get-all-order

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
groupList	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}