Page Comparison

...

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.

...

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

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 uniqueIf more custom fields need to be filled, the request should look like this.

"cycleInfocustomFields": [
  {
    "projectTitlename": "Release 2022-3"
},
"cycleInfo": {ZZEXTERNAL_REF",
    "value": "IMPL-4712"
  },
  {
    "name": "ZZEXTERNAL_URI",
    "releaseCrmIdvalue": "8000000211https://my-jira-instance.com/projects/IMPL/issues/IMPL-4712"
  }

Short description/title of the object

...

]

Change cycle

When assigning a change cycle, either its ID or the description of the cycle can be passed via the JSON object "description" propertycycleInfo". 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.

"descriptioncycleInfo": {
  "projectTitle": "New financial document type \"KR\""

...

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

...

"impact": "75"

...

Priority

The long text of an object priority of the document can be assigned with via the "longtextpriority" 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.

...

Permissible priority values can be looked up in table SCPRIO.

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

Business Partner

...

3"

Urgency

The urgency of a document will be assigned via the "partnerurgency" 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 102CRMC_SRQM_URGENC table contains the allowed values of this field.

"urgency": "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, see https://galileogroup.atlassian.net/wiki/spaces/CONNECTDOCEN/pages/712343577/REST+API+Configuration+REST+API+for+Solution+Manager#Default-text-objects-for-a-transaction-type .

"partnerlongtext": ["This is a detailed description for the requirement.\n Following changes has to be implemented:\n"

Additional text objects

The "texts" array can be used to transfer further texts in addition to the long text via the web service. You must look up the required text IDs in Customizing for the "CRM_ORDERH" object beforehand.

"texts": [
  {
    "partnerFcttextId": "SDCR0001CD01",
    "partnerLookuptext": "151Test report"
  },
  {
    "partnerFct": "SDCR0002",
    "partnerLookup": "102"
  }
]
  {
  "textId": "CD02",
  "text": "Test instructions: \n sample instruction"
  }
]

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"
  }
]

PUT/data/objects/{object_id}

This endpoint is used to update an object based on its object ID. Which values can be updated can be found in the previous chapter POST /data.

PUT/data/external_ids/{external_id}

This endpoint corresponds to the previous one with the difference that the object is addressed via its External ID. This endpoint can only be used if External IDs is always uniquely associated with a Solution Manager object.

POST /data/objects/{object_id}/action/{action_id}/execute

This endpoint can be used to trigger a status transition of an object. The path parameter object_id is the object ID of the object for which the status transition is to be executed and the path parameter action_id must be a valid PPF action name. A list of available PPF actions for an object is provided by the GET /data/objects/{object_id}/action endpoint.

If the action can be executed without errors, the object for which the action was executed is returned. The scheme here corresponds to the endpoint GET /data/objects/{object_id}.

POST /data/external_ids/{external_id}/action/{action_id}/execute

This endpoint works analogously to the previous one with the difference that the object is identified by the External ID.

Endpoint “Cycles”

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

...

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

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

...

Sample Response:

{
    "partner": {
      "number": "00000001510000000118",
      "guid": "00155DF935011ED7A5DA18356AC4E0C4005056A496961EDCA7BCFEE4306C95EB",
      "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.

...