Virima API Specification - InScopeService Services

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

Contents

1 addBusinessInScope POST Interface
2 editBusinessInScope POST Interface
3 getAllInScope GET Interface
4 getAllInScopeDetails GET Interface
5 archiveInScope POST Interface
6 getInScopesForABusinessProcess POST Interface

addBusinessInScope POST Interface

Method: POST

Relative URL: business_inscope/add

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
inscope	InScope

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDBUSINESSINSCOPE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "description":"?",
   "businessService":?,
   "createdBy":"?",
   "createdOn":?,
   "archive":?,
   "lastModifiedBy":"?",
   "lastModifiedOn":?,
   "entityId":?,
   "entity":"?",
   "uniqueId":"?"
}

Example Response:

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

editBusinessInScope POST Interface

Method: POST

Relative URL: business_inscope/edit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
inscope	InScope

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITBUSINESSINSCOPE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "description":"?",
   "businessService":?,
   "createdBy":"?",
   "createdOn":?,
   "archive":?,
   "lastModifiedBy":"?",
   "lastModifiedOn":?,
   "entityId":?,
   "entity":"?",
   "uniqueId":"?"
}

Example Response:

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

getAllInScope GET Interface

Method: GET

Relative URL: business_inscope/get

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
inscope	ValueList

Example Request:

Example Response:

{
   "id":2147483647,
   "StringList":[
      {
         "id":2147483647,
         "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":?
      }   ]
}

getAllInScopeDetails GET Interface

Method: GET

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

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
inscopes	ArrayOfInScope

Example Request:

Example Response:

{
   "id":2147483647,
   "inscopesarray":[
      {
         "id":2147483647,
         "name":"?",
         "description":"?",
         "businessService":?,
         "createdBy":"?",
         "createdOn":?,
         "archive":?,
         "lastModifiedBy":"?",
         "lastModifiedOn":?,
         "entityId":?,
         "entity":"?",
         "uniqueId":"?"
      }   ]
}

archiveInScope POST Interface

Method: POST

Relative URL: business_inscope/archive

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
inscopeId	ArrayOfId

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

getInScopesForABusinessProcess POST Interface

Method: POST

Relative URL: business_inscope/get-all-inscope

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
businessServiceid	RecordID

Response Structure:

Field Name	Type	Description
inscopeList	ArrayOfInScope

Example Request:

GETINSCOPESFORABUSINESSPROCESS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "recordId":"?"
}

Example Response:

{
   "id":2147483647,
   "inscopesarray":[
      {
         "id":492715874,
         "name":"?",
         "description":"?",
         "businessService":?,
         "createdBy":"?",
         "createdOn":?,
         "archive":?,
         "lastModifiedBy":"?",
         "lastModifiedOn":?,
         "entityId":?,
         "entity":"?",
         "uniqueId":"?"
      }   ]
}