Page Comparison

...

Code Block

language	json

"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.

Code Block

language	json

"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 "descriptioncycleInfo" property.

...

. 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.

Code Block

language	json

"description"cycleInfo": {
  "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.

Code Block

language	json

"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.

...

Code Block

language	json

"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.

Code Block

language	json

"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.

Code Block

language	json

"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.

Code Block

language	json

"partnerlongtext": ["This is a {detailed description for the  "partnerFct": "SDCR0001",
    "partnerLookup": "151"
  },
  {
    "partnerFct": "SDCR0002",
    "partnerLookup": "102"
  }
]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.

Code Block

language	json

"texts": [
  {
    "textId": "CD01",
    "text": "Test report"
  },
  {
  "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.

Code Block

language	json

"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.

...

Name	Type	Description
totalObjects	Value	Number of change cycles determinedfound
objects	ArrayArray	with detailed information about List with details of the change cycles found

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

Name	Type	Description
guid	Value	The value contains the globally Global unique ID of the object
objectId	Value	The object Object ID of the object
processType	Value	The associated transaction type of the objectDocument type
postingDate	ValueDate	of creation of the objectCreation date
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	ValueConfiguration	item. This value is not filled during change cycles.Will not be filled at this endpoint!
configItemText	ValueDescription	of the configuration item. This value is not filled during change cycles.Will not be filled at this endpoint!
cycleId	Value	The Same as object ID of the associated change cycle. This value is identical to objectId if the object corresponds to a change cycle.
cycleText	ValueThe	description of the associated change cycle. This value is identical to description if the object corresponds to a change cycle.Same as object description
totalCycleConfigItems	Value	Number of assigned configuration items if the object corresponds to a change cycle
cycleConfigItems	Array	List with associated of assigned configuration items if the object corresponds to a change cycle

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

...

Sample Response:

Code Block

language	json

{
    "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.

...

Version	Old Version 6	New Version 7
Changes made by	Frank Hoogen	Frank Hoogen
Saved on	Mar 25, 2022	Mar 25, 2022

Versions Compared

Key

Short description/title of the object

Change cycle

Short description/title of the object

Desired start, Desired end, Due date

Priority

Business Partner

Urgency

Long text

Additional text objects

Business Partner

PUT/data/objects/{object_id}

PUT/data/external_ids/{external_id}

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

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

Endpoint “Cycles”

Endpoint “Ping”