Tobis API Resource

Abstract class for REST webservices

GET /api/tdxm/tobis/domainid/{domainName}/json

Get domain ID for given name.

Request Parameters
name type description
domainName path Name of domain
Response Body
media type data type description
application/json HdcBasicObjectIdOnlyTO (JSON) JSON Response with list of fields

Example of response:

{"objectId":"233402"}

Example

Request
GET /api/tdxm/tobis/domainid/{domainName}/json
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }
                
              

GET /api/tdxm/tobis/classid/{domainId}/{className}/json

Get class ID for given domain id and class name.

Request Parameters
name type description constraints
className path Name of class  
domainId path ID of domain long
Response Body
media type data type description
application/json object (JSON) JSON Response with list of fields

Example of response:

{"objectId":"19"}

Example

Request
GET /api/tdxm/tobis/classid/{domainId}/{className}/json
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...
                
              

GET /api/tdxm/tobis/fieldid/{classId}/{fieldName}/json

Get field ID for given class id and field name.

Request Parameters
name type description constraints
classId path ID of class long
fieldName path Name of field  
Response Body
media type data type description
application/json HdcBasicObjectIdOnlyTO (JSON) JSON Response with list of fields

Example of response:

{"objectId":"93"}

Example

Request
GET /api/tdxm/tobis/fieldid/{classId}/{fieldName}/json
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }
                
              

GET /api/tdxm/tobis/hdid/{domainId}/{classId}/{fieldId}/{objectGuid}/json

Get HDID of object in HDC DB for given domain id, class id, field id and object GUID.

Request Parameters
name type description constraints
classId path ID of class long
domainId path ID of domain long
fieldId path ID of field long
objectGuid path GUID of object in external domain  
Response Body
media type data type description
application/json HdcBasicTO (JSON) JSON Response with list of fields

Example of response:

{"objectId":"243992"}

Example

Request
GET /api/tdxm/tobis/hdid/{domainId}/{classId}/{fieldId}/{objectGuid}/json
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }
                
              

GET /api/tdxm/tobis/hdidbynames/{domainName}/{className}/{fieldName}/{objectGuid}/json

Get HDID of object in HDC DB for given domain name, class name, field name and object GUID.

Request Parameters
name type description
className path Name of class
domainName path Name of domain
fieldName path Name of field
objectGuid path GUID of object in external domain
Response Body
media type data type description
application/json HdcBasicTO (JSON) JSON Response with list of fields

Example of response:

{"objectId":"243992"}

Example

Request
GET /api/tdxm/tobis/hdidbynames/{domainName}/{className}/{fieldName}/{objectGuid}/json
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }