Virima API Specification - OwnerService Services

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

Contents

1 addOwner POST Interface
2 getAllOwnersNames GET Interface
3 getAllRelationTypes GET Interface
4 archiveOwner POST Interface

addOwner POST Interface

Method: POST

Relative URL: owner/add

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
owner	AddOwner

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDOWNER 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "entityId":?,
   "entity":"?",
   "owner":"?",
   "userId":?,
   "relationType":"?"
}

Example Response:

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

getAllOwnersNames GET Interface

Method: GET

Relative URL: owner/get-all/entity-i-d/entity

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
ownerslist	ArrayOfOwner

Example Request:

Example Response:

{
   "id":2147483647,
   "ownersarray":[
      {
         "id":2147483647,
         "entityId":?,
         "entity":"?",
         "owner":"?",
         "userId":?,
         "relationType":"?"
      }   ]
}

getAllRelationTypes GET Interface

Method: GET

Relative URL: owner/get

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
relationTypes	ValueList

Example Request:

Example Response:

{
   "id":2147483647,
   "StringList":[
      {
         "id":1554591515,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "projectList":[
      {
         "id":2147483647,
         "name":"?",
         "description":?,
         "plannedStart":?,
         "plannedEnd":?,
         "actualStart":?,
         "actualEnd":?,
         "baselineStart":?,
         "baselineEnd":?,
         "status":"?",
         "billingCode":"?",
         "costCenter": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "percentageComplete":?,
         "duration":?,
         "archive":?,
         "projectManager": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "isTemplate":?,
         "templateName":"?",
         "createdFromTemplate":?,
         "createdFromTemplateName":"?",
         "validationError":?,
         "programs":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "associatedCis":[
            {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            }         ],
         "lastModifiedBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdOn":?,
         "lastModifiedOn":?,
         "uniqueId":"?",
         "totalTimeSpent":?
      }   ]
}

archiveOwner POST Interface

Method: POST

Relative URL: owner/archive

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
ownerId	ArrayOfId

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ARCHIVEOWNER 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "ids":[
      {
         "scopeId":?,
         "width":"?",
         "flag":?,
         "calendar":"?"
      }   ]
}

Example Response:

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