Show TOC

Background documentationIntegrating SAP CPS into Third-Party Applications Locate this document in the navigation structure

 

The permalink API allows third-party applications to interact with SAP CPS and create, display, edit, and submit SAP CPS objects, as long as the object allows the action.

You need to have the PermaLink module, which requires the Module.PermaLink license key.

Syntax

api-permalink/(list|show|edit|create|submit|help)?link-objecttype=<objecttype>&(link-path=<name>|link-uniqueid=<n>)

  • <objecttype> - The object type; not all object types are supported. For example, JobDefinition

  • <name> - The full name of the object in the form of <partition>.<objectName>, for example GLOBAL.System_Info

  • <n> - The unique Id of the object.

list

Show the overview page for a certain objecttype

show

Open a show page for the given object

Job Files

For linking to the JobFile show pages, there are extra convenience attributes, which allow to access the JobFile show page by: jobid and (filename or fileorder).

edit

Open the edit windo for the given object, besides in the main window the show

page is also shown for the object.

create

Open a create new object window for the given objecttype.

submit

Open the submit window, optionally with a predefined JobDefinition.

help

Since business keys are preferred for usage in perma links, when you do not know the valid business key path for an object. You can use the help function to obtain the correct path for an object for which you do know the uniqueid.

Prerequisites