Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

This chapter describes the available endpoints of the Connect Solution Manager addon. The base URL of the endpoints is composed of the protocol used (http or https), the hostname, the port and the service as follows:

http(s)://<sap_hostname>:<sap_port>/gal/solman/api/rest/1/

Information about the hostname and ports of your Solution Manager can be viewed via transaction SICF by selecting "Port Information" from the "Goto" menu.

The endpoints can also be passed through the Connect application. The effective endpoints would then essentially look like the following:

http(s)://<connect_hostname>:<connect_port>/repositories/<repository_name>/connections/<connection_name>/events/<event_name>.

Path and query parameters are passed as query parameters when calling web services via the Connect application. The query parameters must always be passed in the Camel Case format. For example, if the path parameter "object_id" exists for an SAP endpoint, this must be passed as the query parameter “objectId” via the Connect application.

Endpoint “Data”

Using the Data endpoint, Change objects can be read, updated, created, and status transitions can be performed.

GET /data/objects/{object_id}

The GET /data/objects/{object_id} endpoint returns information about a change object using the object ID. Object ID means the ten-digit number of the object, for example, the change request ID or the document ID of a change document. The endpoint provides the following information in tabular form.

Name

Type

Description

changedAt

Value

Date of last change

changedBy

Value

Last changer

configurationItem

Object

Configuration element and description

createdAt

Value

Creation date

createdBy

Value

Creator

customFields

Object

All values of the defined custom fields

cycleInfo

Object

Data on the assigned change cycle

description

Value

Title

dueDate

Value

Due date

dueTimestamp

Value

Due date as UTC timestamp

endDate

Value

Date of the desired end

endTimestamp

Value

The desired end as UTC timestamp

externalId

Value

Contains the value of the External ID in case of a 1:1 assignment

externalIds

Array

Contains all assigned External IDs

externalIdsCount

Value

Number of assigned External IDs

impact

Value

Impact of the change object

impactText

Value

Display text for impact.

longtext

Value

Contains the description of the object. Since Change Request Management objects can contain multiple texts, this field contains the text that was stored as default in the addon's Customizing for the associated document type

objectGuid

Value

Unique ID for the object

objectId

Value

Object ID of the object

parentDescription

Value

Short description of the parent object, if a link exists

parentObjectGuid

Value

Unique ID for the parent object, if it exists

parentObjectId

Value

Object ID of the parent object, if it exists

parentProcessType

Value

Document type of the parent object, if it exists

partner

Array

List with information of the assigned information including the number of the business partner, the function of the partner, the name of the business partner and its e-mail address

priority

Value

Priority of the object

priorityText

Value

Display text of the selected priority

processType

Value

Documen type

requests

Array

List of all assigned transport requests with detailed information

requestsAsString

Value

The transport request numbers as a single string separated by line breaks

standardFields

Array

A list of standard fields filled with custom values. The configuration of the addon can be used to control which standard fields can be used

startDate

Value

Date of the desired start

startTimestamp

Value

Date of the desired start as UTC timestamp

texts

Array

List of all object texts

urgency

Value

Urgency

urgencyText

Value

Display text of the selected urgency

userStatus

Value

Current status

userStatusProc

Value

Status scheme used

userStatusText

Value

Display text of the current status

userStatusFinal

Value

Flag ("X" = True, "" = False) indicating whether the current status can no longer be changed

Sample response for a request for change: 

{
   "changedAt": "2021-02-18",
   "changedBy": "GALILEO",
   "configurationItem": {
      "productId": "7100000111",
      "textIbComp": "G00 0020168246 300"
   },
   "createdAt": "2021-01-29",
   "createdBy": "GALILEO",
   "customFields": [
      {
         "name": "CLIENT",
         "value": "100"
      },
      {
         "name": "CUSTOMER_EXT",
         "value": ""
      },
      {
         "name": "CUSTOMER_H_DUMMY",
         "value": ""
      },
      {
         "name": "CUSTOMER_INT",
         "value": ""
      },
      {
         "name": "GUID",
         "value": "00155DF935011EDB98C13B600E6760E0"
      },
      {
         "name": "MODE",
         "value": ""
      },
      {
         "name": "REF_GUID",
         "value": "00155DF935011EDB98C13B600E6760E0"
      },
      {
         "name": "ZZEXTERNAL_ID",
         "value": ""
      },
      {
         "name": "ZZEXTERNAL_REF",
         "value": ""
      },
      {
         "name": "ZZGXP_RISK",
         "value": ""
      },
      {
         "name": "ZZJIRA_ID",
         "value": "BIIMPL01-999"
      },
      {
         "name": "ZZJIRA_URL",
         "value": ""
      }
   ],
   "cycleInfo": {
      "projectTitle": "Phase Cylce (IF_CONIGMA)",
      "releaseType": "I",
      "releaseTypeDescription": "Phase Cycle",
      "releaseCrmId": "8000000211",
      "tasklistId": "",
      "smiProject": "0000000021",
      "slanDesc": "G00 - Solution Manager",
      "sbraName": "Wartung",
      "goLiveDate": "2017-10-02",
      "goLiveTime": "00:00:00",
      "devStartDate": "2017-08-22",
      "devStartTime": "00:00:00",
      "devCloseDate": "2017-08-31",
      "devCloseTime": "00:00:00"
   },
   "description": "Description",
   "dueDate": "2021-02-12",
   "dueTimestamp": "2021-02-12T08:13:33Z",
   "endDate": "2021-09-21",
   "endTimestamp": "2021-09-20T22:00:00Z",
   "externalId": "BIIMPL01-12",
   "externalIds": ["BIIMPL01-12"],
   "externalIdsCount": 1,
   "impact": "00",
   "impactText": "",
   "longtext": "This is the long text.",
   "objectGuid": "00155DF935011EDB98C13B600E6760E0",
   "objectId": "8000001760",
   "parentDescription": "",
   "parentObjectGuid": "00000000000000000000000000000000",
   "parentObjectId": "",
   "parentProcessType": "",
   "partner": [
      {
         "partnerGuid": "00155DF935011EDB98C13B600E7220E0",
         "partnerNumber": "151",
         "partnerFct": "00000001",
         "partnerFctTxt": "Sold-To Party",
         "partnerMain": "X",
         "partnerName": "Mr. XXX",
         "partnerEmail": "XXX@XXX.de",
         "partnerLookup": "",
         "deletionFlag": ""
      },
      {
         "partnerGuid": "00155DF935011EDB98C141D658A540E0",
         "partnerNumber": "151",
         "partnerFct": "SDCD0004",
         "partnerFctTxt": "Current Processor",
         "partnerMain": "X",
         "partnerName": "Mr. XXX",
         "partnerEmail": "XXX@XXX.de",
         "partnerLookup": "",
         "deletionFlag": ""
      },
      {
         "partnerGuid": "00155DF935011EDB98C13B600E7140E0",
         "partnerNumber": "102",
         "partnerFct": "SDCR0001",
         "partnerFctTxt": "Requester",
         "partnerMain": "X",
         "partnerName": "Mr. YYY",
         "partnerEmail": "",
         "partnerLookup": "",
         "deletionFlag": ""
      },
      {
         "partnerGuid": "00155DF935011EDB98C13B600E7260E0",
         "partnerNumber": "151",
         "partnerFct": "SDCR0002",
         "partnerFctTxt": "Change Manager",
         "partnerMain": "X",
         "partnerName": "Mr. XXX",
         "partnerEmail": "XXX@XXX.de",
         "partnerLookup": "",
         "deletionFlag": ""
      }
   ],
   "postingDate": "2021-01-29",
   "priority": "3",
   "priorityText": "3: Medium",
   "processType": "ZMCR",
   "requests": [],
   "requestsAsString": "",
   "standardFields": [
      {
         "name": "/AICRM/EXT_TOKEN",
         "value": "TestValue"
      }
   ],
   "startDate": "2021-01-29",
   "startTimestamp": "2021-01-29T08:13:32Z",
   "texts": [
      {
         "textId": "CR01",
         "text": "This is the long text."
      },
      {
         "textId": "ZZ01",
         "text": "This is a technical problem description."
      },
      {
         "textId": "ZZ02",
         "text": "This is an impact analysis."
      }
   ],
   "urgency": "00",
   "urgencyText": "",
   "userStatus": "E0015",
   "userStatusFinal": "",
   "userStatusProc": "ZMCRHEAD",
   "userStatusText": "Being Implemented"
}

Sample response for the "requests" node:

   "requests": [
   {
         "tasklist": "I000000011",
         "trorderNumber": "G00K900630",
         "text": "",
         "ctsId": "G00_P00005",
         "transportTrack": "TR000005",
         "sysName": "G00",
         "sysType": "ABAP",
         "sysClient": "100",
         "respUser": "DUMMY",
         "createdDate": "2021-01-28",
         "createdTime": "09:04:34",
         "releasedDate": null,
         "releasedTime": "00:00:00",
         "status": "@07@",
         "trfunction": "K",
         "originator": "S",
         "originatorId": "00155DF935011EDB98A7322BD3F5C0E0",
         "originatorKey": "8000001744",
         "trorderCopy": "",
         "projectName": "",
         "criticalObject": false,
         "abortExport": false,
         "csolConflict": false,
         "csolActivated": false,
         "tocNumber": "",
         "trfunctionText": "",
         "codeInspectChk": false,
         "tranpTargetChange": false,
         "openTask": false,
         "emptyRequest": false,
         "taskNumber": "",
         "statusText": "",
         "retrofitStatus": "",
         "collectionId": ""
      },
      {
         "tasklist": "I000000011",
         "trorderNumber": "G00K900632",
         "text": "",
         "ctsId": "G00_P00005",
         "transportTrack": "TR000005",
         "sysName": "G00",
         "sysType": "ABAP",
         "sysClient": "100",
         "respUser": "DUMMY",
         "createdDate": "2021-01-28",
         "createdTime": "09:04:36",
         "releasedDate": null,
         "releasedTime": "00:00:00",
         "status": "@07@",
         "trfunction": "W",
         "originator": "S",
         "originatorId": "00155DF935011EDB98A7322BD3F5C0E0",
         "originatorKey": "8000001744",
         "trorderCopy": "",
         "projectName": "",
         "criticalObject": false,
         "abortExport": false,
         "csolConflict": false,
         "csolActivated": false,
         "tocNumber": "",
         "trfunctionText": "",
         "codeInspectChk": false,
         "tranpTargetChange": false,
         "openTask": false,
         "emptyRequest": false,
         "taskNumber": "",
         "statusText": "",
         "retrofitStatus": "",
         "collectionId": ""
      }
   ]

GET /data/external_ids/{external_id}

The GET /data/external_ids/{external_id} endpoint returns the same information as the GET /data/objects/{object_id} endpoint except that the object is determined based on the linked External ID.

GET /data/objects/{object_id}/children

This endpoint provides all associated linked objects based on an object ID, e.g., if the object ID corresponds to a change request ID, the endpoint provides information about the linked change documents.

The endpoint provides the following information in tabular form.

Name

Type

Description

parentGuid

Value

Unique ID of the object whose linked documents were requested using the object ID.

parentObjectId

Value

Object ID corresponding to the object ID from the endpoint.

parentProcessType

Value

Document type of the object whose linked documents were requested using the object ID.

totalChildren

Value

Number of linked objects.

children

Array

List of objects with details about the linked objects, see the table below.

Tabular view of the information inside the "children" array.

Name

Type

Description

guid

Value

Unique ID of the linked object

objectId

Value

Object ID of the linked object

processType

Value

Document type of the linked object

description

Value

Short description of the linked object

userStatus

Value

Current status

userStatusText

Value

Display text of the current status

userStatusFinal

Value

Flag ("X" = True, "" = False) indicating whether the current status can no longer be changed

Sample Response:

{
   "parentGuid": "00155DF935011EDB98C13B600E6760E0",
   "parentObjectId": "8000001760",
   "parentProcessType": "ZMCR",
   "totalChildren": 2,
   "children":    [
            {
         "guid": "00155DF935011EDB98C164809CF420E0",
         "objectId": "8000001761",
         "processType": "ZMMJ",
         "description": "Demo Change 1",
         "userStatus": "E0002",
         "userStatusText": "In Development",
         "userStatusFinal": ""
      },
            {
         "guid": "00155DF935011EDB98C165411CA980E0",
         "objectId": "8000001762",
         "processType": "ZMMJ",
         "description": "Demo Change 2",
         "userStatus": "E0001",
         "userStatusText": "Created",
         "userStatusFinal": ""
      }
   ]
}

GET /data/external_ids/{external_id}/children

This endpoint returns identical information as the GET /data/objects/{object_id}/children endpoint with the difference that the parent object is determined using the External ID.

GET /data/objects/{object_id}/action

This endpoint provides information of the available PPF actions of the action profile belonging to the object based on a specified object ID. In addition, the endpoint provides an indicator for each PPF action as to whether the action can be executed for the current status.

You can find the PPF actions in Customizing using transaction SPRO via the path “SAP Solution Manager -> Capabilities (Optional) -> Change Control Management -> Transactions -> Actions -> Change Actions and Conditions -> Define Action Profiles and Actions”. The action profile for ChaRM operations is usually as follows <Transaction Type>_ACTIONS, z. B. ZMCR_ACTIONS. Via the customizing path “SAP Solution Manager -> Capabilities (Optional) -> Change Control Management -> Transactions -> Actions -> Assign Action Profile to the Business Transaction Type” can additionally determine exactly what the action profile is for a particular transaction type.

The endpoint returns some information about the requested object ID and an array of PPF actions, which look like the following.

Name

Type

Description

actions

Array

This property returns a list with information about the PPF actions of the object

description

Value

Description of the object

externalID

Value

The assigned External ID of the object, if any

objectGuid

Value

Globally unique ID of the object

objectId

Value

The object ID of the object

processType

Value

The transaction type of the object

The elements of the "actions" array contain the following information about PPF actions.

Name

Type

Description

guid

Value

Globally unique ID of the PPF actions

ttype

Value

PPF Action Name

ttypedescr

Value

The value contains the short description of the PPF action

context

Value

The associated action profile of the PPF action

executable

Value

Flag indicating whether the PPF action can be executed for the current object status. The value "X" corresponds to "True" and the value "" corresponds to "False".

Sample Response:

{
   "actions": [
            {
         "guid": "00155DF935011EDB98C13B600E72E0E0",
         "ttype": "ZMCR_ON_CREATE",
         "ttypedescr": "When First Saving",
         "context": "ZMCR_ACTIONS",
         "executable": ""
      },
...
     {
         "guid": "00155DF935011EDBB1A1C59AA79780E1",
         "ttype": "ZMCR_EXTEND_SCOPE",
         "ttypedescr": "Extend Scope",
         "context": "ZMCR_ACTIONS",
         "executable": "X"
      },
     {
         "guid": "00155DF935011EDBB1A1C59AA79800E1",
         "ttype": "ZMCR_CREATE_PPM_TASK",
         "ttypedescr": "Create Project Management Task",
         "context": "ZMCR_ACTIONS",
         "executable": "X"
      }
   ],
   "description": "Test request for change",
   "externalId": "BIIMPL01-12",
   "objectGuid": "00155DF935011EDB98C13B600E6760E0",
   "objectId": "8000001760",
   "processType": "ZMCR"
}

GET /data/external_ids/{external_id}/action

This endpoint returns the same information based on an External ID about PPF actions of a given object as the GET /data/objects/{object_id}/action endpoint.

GET /data/objects/search

This endpoint is used to search for objects in Solution Manager using predefined filter criteria.

The filter criteria are passed completely as query parameters for this endpoint. The following query parameters can be specified.

Name

Possible values

Description

description

Any case-insensitive text. “*" and "%" can be used as replacement characters for pattern-based searches.

Object description

only_active_status

"true" or "false"

Flag indicating whether only objects with a non-final status are to be returned.

object_id

10-digit object number. A pattern-based search is possible by specifying "*" or "%".

Object ID

configuration_item

The configuration item as a string. A pattern-based search for the configuration item is not possible.

Configuration item

product_id

The configuration item as a string. A pattern-based search for the configuration item is not possible.

Configuration item (alternative name)

posting_date

Date in the form YYYY-MM-DD

Posting or creation date

object_type

The following fixed values are allowed:
RFC = Change request
CR = Change document
CCY = Change cycle
DEF = Defect

Object type

The response of the endpoint corresponds to the table below.

Name

Type

Description

totalObjects

Value

Number of objects determined

objects

Array

Array with detailed information about the objects found

The objects from the array "objects" contain the following values.

Name

Type

Description

guid

Value

The value contains the globally unique ID of the object

objectId

Value

The object ID of the object

processType

Value

The associated transaction type of the object

postingDate

Value

Date of creation of the object was

description

Value

Object Description.

userStatus

Value

Current status

userStatusText

Value

Display text of the current status

userStatusFinal

Value

Flag ("X" = True, "" = False) indicating whether the current status can no longer be changed

configItem

Value

Configuration item. This value is not filled during change cycles.

configItemText

Value

Description of the configuration item. This value is not filled during change cycles.

cycleId

Value

The object ID of the associated change cycle. This value is identical to objectId if the object corresponds to a change cycle.

cycleText

Value

The description of the associated change cycle. This value is identical to description if the object corresponds to a change cycle.

totalCycleConfigItems

Value

Number of configuration items if the object corresponds to a change cycle

cycleConfigItems

Array

List with associated configuration items if the object corresponds to a change cycle

The items from the cycleConfigItems field correspond to the following format:

Name

Type

Description

configItem

Value

Configuration item

configItemText

Value

Description of the configuration item

Sample Response:

{
   "totalObjects": 1,
   "objects": [
      {
         "guid": "00155DF935011ED7A690FB3043D0E0C4",
         "objectId": "8000000260",
         "processType": "ZMCR",
         "postingDate": "2017-09-13",
         "description": "Demo Change Request",
         "userStatus": "E0011",
         "userStatusText": "Extend Scope",
         "userStatusFinal": "",
         "configItem": "7100000111",
         "configItemText": "G00 0020168246 300",
         "cycleId": "8000000211",
         "cycleText": "Phase cycle (IF_CONIGMA)",
         "totalCycleConfigItems": 0,
         "cycleConfigItems": []
      }
   ]
}

POST /data

This endpoint can be used to create new objects in Solution Manager. The endpoint additionally accepts the query parameter "simulation" to simulate the creation of an object. To simulate the creation of an object, the parameter must be assigned either the value "True" or "X", e.g. "http(s)//: ... /data?simulation=True"

The request must contain at least one value for the transaction type via the "processType" property in order to create an object.

The following object values are currently supported if they are included in the request.

Configuration item

The configuration item or IBase component is a JSON object named "configurationItem" with properties "productId" for the configuration item and "textIbComp" for the description of the configuration item, where only the value for "productId" is relevant for creation or modification.

"configurationItem": {
  "productId": "7100000111"
}
Custom fields

All custom fields that exist in the CRMD_CUSTOMER_H table and begin with either ZZ or YY can be passed when creating an object.

For example, if the custom field YYJIRA_URL is to contain the URL of a linked Jira Issue, the following can be passed in the request. The field name must be passed in lowercase in the "customFields" object. If the name contains an underscore, the next letter after the underscore must be specified in upper case.

"customFields": {
  "yyjiraUrl": "https://my-jira-instance.com/projects/IMPL/issues/IMPL-4712"
}
Change cycle

When assigning a change cycle, either its ID or the description of the cycle can be passed via the JSON object "cycleInfo". The property "releaseCrmId" corresponds to the ID of the cycle and "projectTitle" corresponds to the description of the cycle.

If you want to assign a cycle with ID 8000000211 with description "Release 2022-3" to an object, you can supply either the ID or the description, provided that the description is unique.

"cycleInfo": {
  "projectTitle": "Release 2022-3"
},
"cycleInfo": {
  "releaseCrmId": "8000000211"
}
Short description/title of the object

The short description or title of the object can be passed via the "description" property.

"description": "New financial document type \"KR\""
Desired start, Desired end, Due date

The date fields Desired start, Desired end or Due date can be passed via the properties "startDate", "endDate" and "dueDate". The date format corresponds to the pattern YYYY-MM-DD.

"dueDate": "2021-02-15",
"endDate": "2022-03-18",
"startDate": "2022-01-15"
External ID

An External ID, such as a Jira Issue ID or a ServiceNow Incident ID, can be set using the "externalId" property.

"externalId": "IMPL-4712"
Multiple External IDs

If the assignment of multiple external IDs is allowed for certain transaction types, a set of external IDs can be passed directly via the array property "externalIds".

"externalIds": [
  "IMPL-4712",
  "IMPL-4713"
]
Impact of a requirement, change or problem

The impact of a requirement, change or problem can be assigned via the "impact" property. Permissible values for the impact, can be found in table CRMC_SRQM_IMPACT.

"impact": "75"
Long text

The long text of an object can be assigned with the "longtext" property. Since the associated text type depends on the transaction type and customer-specific text types may be used, a text type must be assigned in advance in the configuration of the add-on for each transaction type that is to be used as long text.

"longtext": "This is a detailed description for the requirement.\n Following changes has to be implemented:\n"
Business Partner

Business partners relevant in the process can be assigned via the "partner" property. The property is an array with objects, whereby at least the partner function "partnerFct" and a search text "partnerLookup" must be specified for an object. The search text works in the same way as entering a partner in the web frontend of the Solution Manager and, for example, the number or the last name of the partner can be specified. It is also possible to implement customer-specific mapping rules for business partners.

Please note that the partner function depends on the transaction type. The available partner functions for a transaction type can be found in table AIC_PARTNER_FCT. In the following example, the role "Requester" is assigned to business partner 151 and the role "Change Manager" is assigned to business partner 102.

"partner": [
  {
    "partnerFct": "SDCR0001",
    "partnerLookup": "151"
  },
  {
    "partnerFct": "SDCR0002",
    "partnerLookup": "102"
  }
]

Endpoint “Cycles”

Using the Cycles endpoint, information about change cycles can be retrieved from Solution Manager.

GET /cycles

This endpoint returns an array with the following information about all change cycles in the system. The return format is still used by another endpoint, which is why identical values are returned in different fields for change cycles. The response of the endpoint contains the following fields.

Name

Type

Description

totalObjects

Value

Number of change cycles determined

objects

Array

Array with detailed information about the change cycles

The objects from the array "objects" contain the following values.

Name

Type

Description

guid

Value

The value contains the globally unique ID of the object

objectId

Value

The object ID of the object

processType

Value

The associated transaction type of the object

postingDate

Value

Date of creation of the object

description

Value

Object description

userStatus

Value

Current status

userStatusText

Value

Display text of the current status

userStatusFinal

Value

Flag ("X" = True, "" = False) indicating whether the current status can no longer be changed

configItem

Value

Configuration item. This value is not filled during change cycles.

configItemText

Value

Description of the configuration item. This value is not filled during change cycles.

cycleId

Value

The object ID of the associated change cycle. This value is identical to objectId if the object corresponds to a change cycle.

cycleText

Value

The description of the associated change cycle. This value is identical to description if the object corresponds to a change cycle.

totalCycleConfigItems

Value

Number of configuration items if the object corresponds to a change cycle

cycleConfigItems

Array

List with associated configuration items if the object corresponds to a change cycle

The items from the cycleConfigItems field correspond to the following format:

Name

Type

Description

configItem

Value

Configuration item

configItemText

Value

Description of the configuration item.

Sample Response:

{
   "totalObjects": 2,
   "objects": [          
      {
         "guid": "00155DF935011ED7A1E4396415E380C3",
         "objectId": "8000000211",
         "processType": "SMIM",
         "postingDate": "2017-08-22",
         "description": "Phase cycle (IF_CONIGMA)",
         "userStatus": "E0004",
         "userStatusText": "Build",
         "userStatusFinal": "",
         "configItem": "",
         "configItemText": "",
         "cycleId": "8000000211",
         "cycleText": "Phase cycle (IF_CONIGMA)",
         "totalCycleConfigItems": 1,
         "cycleConfigItems": [
            {
               "configItem": "7100000111",
               "configItemText": "G00 0020168246 300"
            }
         ]
      },
      {
         "guid": "00155DF935011EDB95E11001AEB600E0",
         "objectId": "8000001677",
         "processType": "SMIM",
         "postingDate": "2021-01-15",
         "description": "Cycle for defects",
         "userStatus": "E0005",
         "userStatusText": "Test",
         "userStatusFinal": "",
         "configItem": "",
         "configItemText": "",
         "cycleId": "8000001677",
         "cycleText": "Cycle for defects",
         "totalCycleConfigItems": 1,
         "cycleConfigItems": [  
            {
               "configItem": "7100000111",
               "configItemText": "G00 0020168246 300"
            }
         ]
      }
   ]
}

GET /cycles/transaction_types/{transaction_type}

This endpoint returns all change cycles that may be used for a specific document type, e.g., SMCR. The response is structured identically to the response of the GET /cycles endpoint.

Endpoint “Partner”

Using the "Partner" endpoint, information on business partners can be retrieved from Solution Manager.

GET /data/partner?email={emailAddress)

This endpoint provides detailed information about a business partner based on the email address from Solution Manager in the "partner" return field.

Name

Type

Description

number

Value

Business partner number

guid

Value

GUID of the business partner

firstname

Value

First name of the business partner

lastname

Value

Last name of the business partner

email

Value

E-mail address of the business partner

validFrom

Value

Valid-from date of the business partner

validTo

Value

Valid-to date of the business partner

Sample Response:

{
   "partner": {
      "number": "0000000151",
      "guid": "00155DF935011ED7A5DA18356AC4E0C4",
      "firstname": "Frank",
      "lastname": "Dummy",
      "email": "frank.dummy@dummy.de",
      "validFrom": "0001-01-01",
      "validTo": "9999-12-31"
   }
}

Endpoint “Ping”

The "Ping" endpoint is used to test connections.

GET /ping

This endpoint is mainly used for testing connections and returns the following information about the called SAP system and includes the following fields.

Name

Type

Description

serverInfo

Object

Information on the SAP Server

systemTime

Value

Current system time

The object "serverInfo" contains the following information.

Name

Type

Description

name

Value

Application Server Instance

host

Value

Name of the host server

serv

Value

Service

msgtypes

Value

Services of the Application Server Instance

hostadr

Value

Host IP address

servno

Value

Port number of the service

state

Value

Server status

hostnamelong

Value

Host name

hostaddrV4Str

Value

IPv4 address

hostaddrV6Str

Value

IPv6 address

sysservervice0

Value

System Services Registered on Message Server

sysservervice1

Value

System Services Registered on Message Server

sysservervice2

Value

System Services Registered on Message Server

sysservervice3

Value

System Services Registered on Message Server

Sample Response:

{
   "serverInfo":
   {
      "name": "GAL-MCH-116_G00_00",
      "host": "GAL-MCH-116",
      "serv": "sapdp00",
      "msgtypes": "BB",
      "hostadr": "C0A80174",
      "servno": "0C80",
      "state": "01",
      "hostnamelong": "GAL-MCH-116",
      "hostaddrV4Str": "192.168.1.116",
      "hostaddrV6Str": "192.168.1.116",
      "sysservice0": "80",
      "sysservice1": "00",
      "sysservice2": "00",
      "sysservice3": "00"
   },
   "systemTime": "2021-06-04T09:14:45.159Z"
}

Endpoint “Tables”

Via this endpoint, contents of "any" SAP tables can be requested. However, the tables whose contents may be read must be specified beforehand via the configuration program /GAL/SM_API_CONFIG.

GET /tables/{table_name}

This endpoint is the basic endpoint to resolve contents of SAP tables. The endpoint has the following variations to specify up to 4 filter criteria. As a filter option only the check for equality or for a pattern is currently supported. If a pattern check is to be performed, the substitution characters "*" and "%" can be specified.

The following endpoint variants exist.

/tables/{table_name}/filter/column/{filter_column}/value/{filter_value}

/tables/{table_name}/filter/column/{filter_column}/value/{filter_value}/column2/{filter_column2}/value2/{filter_value2}

/tables/{table_name}/filter/column/{filter_column}/value/{filter_value}/column2/{filter_column2}/value2/{filter_value2}/column3/{filter_column3}/value3/{filter_value3}

/tables/{table_name}/filter/column/{filter_column}/value/{filter_value}/column2/{filter_column2}/value2/{filter_value2}/column3/{filter_column3}/value3/{filter_value3}/column4/{filter_column4}/value4/{filter_value4}

If the specified table exists and is allowed to be read via the endpoint, the return will contain the following two fields.

Name

Type

Description

totalRecords

Value

Number of records read

records

Array

Array of the read records, where the field names correspond to the column names of the table (in Camel Case)

Sample Response:

{
   "totalRecords": 1,
   "records": [
      {
         "mandt": "100",
         "productId": "7100000111",
         "configItem": "AS-SAP-SOLMAN",
         "gxpClass": "GXP",
         "processTeam": "Defect Mngmt. 7.2",
         "scrReviewerDl": ""
      }
   ]
}

The above example returns the field values of a table with the columns MANDT, PRODUCT_ID, CONFIG_ITEM, GXP_CLASS, PROCESS_TEAM and SCR_REVIEWER_DL.

  • No labels