SAP ABAP Interface IF_CTS_REST_API (Rest API interface)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CTS-ORG-PLS (Application Component) Transport Organizer für non-ABAP (CTS+)
     ⤷ SCTS_REQ_RES_API (Package) Organizer Interface for REST API

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_CTS_REST_API_IMPL	Rest API Implementation	20120605

Properties

Interface	IF_CTS_REST_API
Short Description	Rest API interface

General Data

Package	SCTS_REQ_RES_API	Organizer Interface for REST API
Created	20120605	SAP
Last changed	20130531	SAP
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	STRHI	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	TRWBO	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Interface IF_CTS_REST_API has no interface.

Friends

Interface IF_CTS_REST_API has no friend.

Attributes

Interface IF_CTS_REST_API has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_NEW_TASK	Instance method	Public	Method		20120619
2	ADD_OBJECT_TO_REQUEST	Instance method	Public	Method		20120705
3	CHANGE_OWNER	Instance method	Public	Method		20120703
4	CHECK	Instance method	Public	Method		20120702
5	CHECK_OBJECTS_AND_KEYS	Instance method	Public	Method		20120702
6	CREATE_REQUEST_FROM_PACKAGE	Instance method	Public	Method		20120620
7	DELETE	Instance method	Public	Method		20120619
8	GET_CLIENT_TEXT	Instance method	Public	Method		20120802
9	GET_OBJECT_TEXTS	Instance method	Public	Method		20120606
10	GET_REQUEST_DATA	Instance method	Public	Method	Get request data	20120613
11	GET_REQUEST_TEXTS	Instance method	Public	Method		20120618
12	GET_TARGET_TEXT	Instance method	Public	Method		20120802
13	LOCK	Instance method	Public	Method		20120627
14	RELEASE	Instance method	Public	Method		20120621
15	SELECT_REQUESTS	Instance method	Public	Method		20120605
16	UNLOCK	Instance method	Public	Method		20120627

Events

Interface IF_CTS_REST_API has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_OBJ_CHECK_RESULT	Public	See coding			20121004	BEGIN OF ty_obj_check_result. include TYPE trcheckresext. types check_ref type string. types errortab TYPE TROBJCHECKERRTAB. TYPES: END OF ty_obj_check_result
2	TY_OBJ_CHECK_RESULTS	Public	See coding			20121004	ty_obj_check_results TYPE TABLE OF ty_obj_check_result
3	TY_PACK_CHECK_RESULT	Public	See coding			20121004	BEGIN OF ty_pack_check_result, object TYPE trobjtype, obj_name TYPE trobj_name. INCLUDE TYPE SYMSG. TYPES: END OF ty_pack_check_result
4	TY_PACK_CHECK_RESULTS	Public	See coding			20121004	ty_pack_check_results TYPE TABLE OF ty_pack_check_result

Method Signatures

Method ADD_NEW_TASK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_TASK_ID	Call by reference	☐	Type reference (TYPE)	TRKORR		Auftrag/Aufgabe	20120619
2	Importing	IV_LOCK_HANDLE	Call by reference	☑	Type reference (TYPE)	CTS_LOCK_HANDLE			20120627
3	Importing	IV_TASK_OWNER	Call by reference	☐	Type reference (TYPE)	SYUNAME	SY-UNAME		20120703
4	Importing	IV_TRKORR	Call by reference	☐	Type reference (TYPE)	TRKORR			20120619

#	Exception	Resumable	Description	Created on
1	CX_CTS_REST_API_EXCEPTION	☐		20120619

Method ADD_OBJECT_TO_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_E071	Call by reference	☐	Type reference (TYPE)	TRWBO_T_E071			20120705
2	Changing	CT_E071K	Call by reference	☑	Type reference (TYPE)	TRWBO_T_E071K			20120706
3	Importing	IV_LOCK_HANDLE	Call by reference	☑	Type reference (TYPE)	CTS_LOCK_HANDLE			20120705
4	Importing	IV_TRKORR	Call by reference	☐	Type reference (TYPE)	TRKORR			20120705

#	Exception	Resumable	Description	Created on
1	CX_CTS_REST_API_EXCEPTION	☐		20120705

Method CHANGE_OWNER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LOCK_HANDLE	Call by reference	☑	Type reference (TYPE)	CTS_LOCK_HANDLE			20120703
2	Importing	IV_TRKORR	Call by reference	☐	Type reference (TYPE)	TRKORR			20120703
3	Importing	IV_UNAME	Call by reference	☐	Type reference (TYPE)	SYUNAME	SY-UNAME		20120703

#	Exception	Resumable	Description	Created on
1	CX_CTS_REST_API_EXCEPTION	☐		20120703

Method CHECK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_E071	Call by reference	☐	Type reference (TYPE)	TRWBO_T_E071			20120730
2	Exporting	ET_E071K	Call by reference	☐	Type reference (TYPE)	TRWBO_T_E071K			20120730
3	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	CTSGERRMSGS			20120702
4	Importing	IV_CHECK_LOCKABILITY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20120730
5	Importing	IV_TRKORR	Call by reference	☐	Type reference (TYPE)	TRKORR			20120702

#	Exception	Resumable	Description	Created on
1	CX_CTS_REST_API_EXCEPTION	☐		20120702

Method CHECK_OBJECTS_AND_KEYS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_SLIN_RES	Call by reference	☐	Object reference (TYPE REF TO)	CL_CI_TRANSPORT_CHECK			20120704
2	Exporting	ET_CHECK_SUMMARY	Call by reference	☐	Type reference (TYPE)	TRCHECKRESEXT_TAB		Objektprüfungen: Ergebnis (mit Prüfungs-Id)	20120704
3	Exporting	ET_DOCU_RES	Call by reference	☐	Type reference (TYPE)	TRDOCURESULTS		Ergebnisse der Doku-Prüfung	20120704
4	Exporting	ET_GTABKEY_RES	Call by reference	☐	Type reference (TYPE)	GTABKEYERROR		Fehlermeldungen nach Globalem Key Check	20120704
5	Exporting	ET_PACK_RES	Call by reference	☐	Type reference (TYPE)	TY_PACK_CHECK_RESULTS		Tabelle mit Meldungen der Paketprüfung für DDIC-Objekte	20120704
6	Exporting	EV_ATC_RES	Call by reference	☐	Type reference (TYPE)	STRING			20121009
7	Importing	IV_TRKORR	Call by reference	☐	Type reference (TYPE)	TRKORR			20120702

#	Exception	Resumable	Description	Created on
1	CX_CTS_REST_API_EXCEPTION	☐		20120702

Method CREATE_REQUEST_FROM_PACKAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DESCRIPTION	Call by reference	☐	Type reference (TYPE)	AS4TEXT		Kurzbeschreibung von Repository-Objekten	20120620
2	Importing	PACKAGENAME	Call by reference	☐	Type reference (TYPE)	DLVUNIT		Softwarekomponente	20120620
3	Importing	REQUEST_CATEGORY	Call by reference	☐	Type reference (TYPE)	TRFUNCTION	'K'	Typ des Auftrags/Aufgabe	20120620
4	Importing	TRANSPORTLAYER	Call by reference	☑	Type reference (TYPE)	DEVLAYER		Transportschicht in der ABAP Workbench	20120620
5	Returning	TRKORR	Value transfer	☐	Type reference (TYPE)	TRKORR		Auftrag/Aufgabe	20120620

#	Exception	Resumable	Description	Created on
1	CX_CTS_REST_API_EXCEPTION	☐	CTS REST API Exception	20120620

Method DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LOCK_HANDLE	Call by reference	☑	Type reference (TYPE)	CTS_LOCK_HANDLE			20120627
2	Importing	IV_TRKORR	Call by reference	☐	Type reference (TYPE)	TRKORR			20120619

#	Exception	Resumable	Description	Created on
1	CX_CTS_REST_API_EXCEPTION	☐		20120619

Method GET_CLIENT_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CLIENT_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20120802
2	Importing	IV_CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT			20120802

#	Exception	Resumable	Description	Created on
1	CX_CTS_REST_API_EXCEPTION	☐		20120802

Method GET_OBJECT_TEXTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_TYPES_TEXT	Call by reference	☐	Type reference (TYPE)	TR_OBJECT_TEXTS		CTS: Objekttypen mit Beschreibung	20120606
2	Importing	IT_TYPES_SEL	Call by reference	☑	Type reference (TYPE)	CTS_OBJTYPE_TAB		Objekttypen	20120606
3	Importing	IV_COMPLETE	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20120606

#	Exception	Resumable	Description	Created on
1	CX_CTS_REST_API_EXCEPTION	☐	CTS REST API Exception	20120606

Method GET_REQUEST_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_REQUEST	Call by reference	☐	Type reference (TYPE)	TRWBO_REQUEST		Request/Task Data	20120613
2	Importing	IV_READ_ATTRIBUTES	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	' '	Read Attributes	20120613
3	Importing	IV_READ_CLIENT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	' '	Read Source/Target Client of Requests/Tasks	20120613
4	Importing	IV_READ_DESCR	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	' '	Read Short Texts for Requests/Tasks	20120613
5	Importing	IV_READ_HEADERS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	' '	Read Headers of Requests/Tasks	20120613
6	Importing	IV_READ_OBJS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	' '	Read Objects	20120613
7	Importing	IV_READ_OBJS_KEYS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	' '	Read Object Keys	20120613
8	Importing	IV_READ_TARGET	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	' '	Read Target Package/Layer for Requests	20120613

#	Exception	Resumable	Description	Created on
1	CX_CTS_REST_API_EXCEPTION	☐	CTS REST API Exception	20120613

Method GET_REQUEST_TEXTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_REQUEST_STATUS_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20120618
2	Exporting	EV_REQUEST_TYPE_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20120618
3	Exporting	EV_REQUEST_TYPE_TEXT_LONG	Call by reference	☐	Type reference (TYPE)	STRING			20120618
4	Importing	IV_REQUEST_STATUS	Call by reference	☑	Type reference (TYPE)	TRSTATUS			20120618
5	Importing	IV_REQUEST_TYPE	Call by reference	☑	Type reference (TYPE)	TRFUNCTION			20120618

#	Exception	Resumable	Description	Created on
1	CX_CTS_REST_API_EXCEPTION	☐		20120618

Method GET_TARGET_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_TARGET_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20120802
2	Importing	IV_TARGET	Call by reference	☐	Type reference (TYPE)	TR_TARGET			20120802

#	Exception	Resumable	Description	Created on
1	CX_CTS_REST_API_EXCEPTION	☐		20120802

Method LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_LOCK_HANDLE	Call by reference	☐	Type reference (TYPE)	CTS_LOCK_HANDLE			20120627
2	Importing	IV_TRKORR	Call by reference	☐	Type reference (TYPE)	TRKORR			20120627

#	Exception	Resumable	Description	Created on
1	CX_CTS_REST_API_EXCEPTION	☐	CTS REST API Exception	20120704

Method RELEASE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	CTSGERRMSGS			20120718
2	Exporting	ET_OBJ_CHECK_RESULTS	Call by reference	☐	Type reference (TYPE)	TY_OBJ_CHECK_RESULTS			20121004
3	Importing	IV_IGNORE_LOCKS	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20120720
4	Importing	IV_IGNORE_OBJECTS_CHECK	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20121005
5	Importing	IV_LOCK_HANDLE	Call by reference	☑	Type reference (TYPE)	CTS_LOCK_HANDLE			20120627
6	Importing	IV_SIMULATION	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20121005
7	Importing	IV_TRKORR	Call by reference	☐	Type reference (TYPE)	TRKORR			20120621

#	Exception	Resumable	Description	Created on
1	CX_CTS_REST_API_CRIT_OBJ_ERROR	☐		20120926
2	CX_CTS_REST_API_DISP_OBJ_ERROR	☐		20120926
3	CX_CTS_REST_API_EXCEPTION	☐		20120621
4	CX_CTS_REST_API_INAC_OBJ_ERROR	☐		20120926
5	CX_CTS_REST_API_OBJ_LOCK_DISPL	☐		20120926
6	CX_CTS_REST_API_OBJ_LOCK_ERROR	☐		20120720
7	CX_CTS_REST_API_RELEASE_FAIL	☐		20120720
8	CX_CTS_REST_API_REQ_CONS_ERROR	☐		20120926

Method SELECT_REQUESTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CRITERIA	Call by reference	☑	Type reference (TYPE)	TRWBO_SELECTIONS			20120605
2	Changing	REQUESTS	Call by reference	☐	Type reference (TYPE)	STRHI_REQUESTS_WD			20120605
3	Importing	USER	Call by reference	☑	Type reference (TYPE)	SYUNAME		Benutzername	20120605

#	Exception	Resumable	Description	Created on
1	CX_CTS_REST_API_EXCEPTION	☐	Keine Berechtigung	20120605

Method UNLOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TRKORR	Call by reference	☐	Type reference (TYPE)	TRKORR			20120627

Method UNLOCK on Interface IF_CTS_REST_API has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	740