In the Service panel resides a folder API where you can define your own service APIs.

Go to the API folder in the service panel of your service.

First you need to create the API needed for your service inside the API folder. All other elements will be created within this API. Add a new API via the quick action or the context menu. Refer to API for more information on how to create a new API in the API folder.

Tip

title	Expert Advice

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	hint_naming_conventions
PageWithExcerpt	INTERNAL:_designer_excerpts

API Elements

To define a service API, you have the following elements available:

Element

Description

Details

API

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	api
PageWithExcerpt	INTERNAL:_designer_excerpts
shouldDisplayInlineCommentsInIncludes	false

API

Port

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	port
PageWithExcerpt	INTERNAL:_designer_excerpts
shouldDisplayInlineCommentsInIncludes	false

Port

Class

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	class
PageWithExcerpt	INTERNAL:_designer_excerpts
shouldDisplayInlineCommentsInIncludes	false

Class

Class

Classes can have sub-classes.

Operation

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	operation
PageWithExcerpt	INTERNAL:_designer_excerpts
shouldDisplayInlineCommentsInIncludes	false

Operation

Parameter

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	interface
PageWithExcerpt	INTERNAL:_designer_excerpts
shouldDisplayInlineCommentsInIncludes	false

Parameter

Interface

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	interface
PageWithExcerpt	INTERNAL:_designer_excerpts
shouldDisplayInlineCommentsInIncludes	false

Interface

Interface

Interfaces can have sub-interfaces and sub-classes.

Class

Operation

Operations and parameters for interfaces are the same as for classes. The difference is that they have no implementation but only define the signature for the dependent classes to derive from.

Operation

Parameter

Parameter

Each element of the API folder has a context menu and quick actions. The context menu contains options to create new elements to the selected element, and to edit the current element. Via the quick actions, you can access the most used menu items directly with a single click.

API

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	api
PageWithExcerpt	INTERNAL:_designer_excerpts
shouldDisplayInlineCommentsInIncludes	false

The quick action of an API allows for the creation of ports.

Quick Action	Description
	Add a port to the API.

The context menu of an API allows you to create a port, to cut, copy and paste the API, to change the name of the API, and to delete it.

Menu Item	Description
Add Port	Add a port to the API
Cut	Cut the API to paste it elsewhere to the API folder.
Copy	Copy the API to paste it elsewhere to the API folder.
Paste	Paste the API elsewhere to the API folder. Available if Copy or Cut option have been used before.
Rename	Change the API name.
Delete	Delete the API.

Port

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	port
PageWithExcerpt	INTERNAL:_designer_excerpts
shouldDisplayInlineCommentsInIncludes	false

The context menu of a port allows for the creation of classes and interfaces, to change the name of the port, and to delete it.

Menu Item	Description
Add Class	Add a class to the port.
Add Interface	Add an interface to the port.
Rename	Change the port name.
Delete	Delete the port.

Class

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	class
PageWithExcerpt	INTERNAL:_designer_excerpts
shouldDisplayInlineCommentsInIncludes	false

The quick actions of a class allow for the creation of operations with different types of implementation.

Quick Action

Description

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	add_mapping_operation
PageWithExcerpt	INTERNAL:_designer_excerpts

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	add_action_script
PageWithExcerpt	INTERNAL:_designer_excerpts

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	add_activity_operation
PageWithExcerpt	INTERNAL:_designer_excerpts

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	add_operation
PageWithExcerpt	INTERNAL:_designer_excerpts

The context menu of a class allows you to create further elements, to cut, copy and paste the class, to change the name of the class, and to delete it.

Menu Item

Description

Add Class

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	add_sub_class
PageWithExcerpt	INTERNAL:_designer_excerpts

Add Interface

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	add_interface
PageWithExcerpt	INTERNAL:_designer_excerpts

Add Operation

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	add_operation_cm
PageWithExcerpt	INTERNAL:_designer_excerpts

Cut

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	cut_class
PageWithExcerpt	INTERNAL:_designer_excerpts

Copy

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	copy_class
PageWithExcerpt	INTERNAL:_designer_excerpts

Paste

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	paste_class
PageWithExcerpt	INTERNAL:_designer_excerpts

Rename

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	rename_class
PageWithExcerpt	INTERNAL:_designer_excerpts

Delete

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	delete_class
PageWithExcerpt	INTERNAL:_designer_excerpts

Operation

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	operation
PageWithExcerpt	INTERNAL:_designer_excerpts
shouldDisplayInlineCommentsInIncludes	false

The quick actions of an operation allow for the creation of parameters with different directions, and to jump to the implementation of the operation.

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	operation_quick_actions
PageWithExcerpt	INTERNAL:_designer_excerpts

The context menu of an operation allows you to create further elements, to select and change the type of implementation of the operation and to open the implementation of the operation. Furthermore you can cut, copy and paste the operation, change the name of the operation, and delete it via this menu.

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	operation_context_menu
PageWithExcerpt	INTERNAL:_designer_excerpts

Parameter

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	parameter
PageWithExcerpt	INTERNAL:_designer_excerpts
shouldDisplayInlineCommentsInIncludes	false

The context menu of a parameter allows you to change the order of parameters as well as to change the names of a parameter. Furthermore you can cut, copy and paste a parameter. It is not possible to create further elements below a parameter.

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	parameter_context_menu
PageWithExcerpt	INTERNAL:_designer_excerpts

Tip

If you want to change the direction of a parameter, select the parameter and change attribute Direction in the Attributes panel:

Interface

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	interface
PageWithExcerpt	INTERNAL:_designer_excerpts
shouldDisplayInlineCommentsInIncludes	false

The quick action of an interface allows for the creation of operations.

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	interface_quick_action
PageWithExcerpt	INTERNAL:_designer_excerpts

The Interface context menu allows you to create further elements and to change the name of the interface. Furthermore you can cut, copy and paste as well as delete the interface via this menu.

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	interface_context_menu
PageWithExcerpt	INTERNAL:_designer_excerpts

Panel

title	On this Page:

Table of Contents

OtpFloatingfalse

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	RESTAPI_SupportManager_Example
PageWithExcerpt	INTERNAL:_designer_examples
shouldDisplayInlineCommentsInIncludes	false

rp

Panel

title	Related Pages:

Page tree

Versions Compared

Old Version 4

New Version Current

Key

API Elements

API

Port

Class

Operation

Parameter

Interface

Page tree

Page History

Versions Compared

Old Version 4

New Version Current

Key

API Elements

API

Port

Class

Operation

Parameter

Interface