SAP ABAP Interface IF_REST_REQUEST (REST Request)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-MID-RST (Application Component) REST-based Protocols
⤷
SREST_CORE (Package) REST Core

⤷

⤷

Meta Relationship - Used By
# | Relationship type | Used by | Short Description | Created on |
---|---|---|---|---|
1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_REST_BASE_REQUEST | REST Base Request | 20120302 |
2 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_REST_REQUEST | REST Request | 20120325 |
Properties
Interface | IF_REST_REQUEST | |
Short Description | REST Request |
General Data
Package | SREST_CORE | REST Core |
Created | 20100208 | 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) |
Interfaces
# | Interface | Abstract | Final | Description | Created on |
---|---|---|---|---|---|
1 | IF_REST_MESSAGE | REST Messages | 20100208 |
Friends
Interface IF_REST_REQUEST has no friend.
Attributes
# | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | GC_HEADER_CSRF_TOKEN | Constant | Public | Type reference (TYPE) | STRING | 'X-CSRF-Token' | Header Field for CSRF Token | 20110906 | |
2 | GC_HEADER_HTTP_METHOD | Constant | Public | Type reference (TYPE) | STRING | 'X-HTTP-Method' | Alternative Header Field for HTTP Method Override | 20101020 | |
3 | GC_HEADER_METHOD_OVERRIDE | Constant | Public | Type reference (TYPE) | STRING | 'X-HTTP-Method-Override' | Header Field for Method Override | 20100217 | |
4 | GC_HEADER_REQUESTED_WITH | Constant | Public | Type reference (TYPE) | STRING | 'X-Requested-With' | Header Field for CSRF Protection | 20100408 | |
5 | GC_METHOD_DELETE | Instance attribute | Public | Attribute reference (LIKE) | 20100302 | ||||
6 | GC_METHOD_GET | Instance attribute | Public | Attribute reference (LIKE) | 20100302 | ||||
7 | GC_METHOD_HEAD | Instance attribute | Public | Attribute reference (LIKE) | 20100302 | ||||
8 | GC_METHOD_MERGE | Instance attribute | Public | Attribute reference (LIKE) | 20110727 | ||||
9 | GC_METHOD_OPTIONS | Instance attribute | Public | Attribute reference (LIKE) | 20100302 | ||||
10 | GC_METHOD_PATCH | Instance attribute | Public | Attribute reference (LIKE) | 20110727 | ||||
11 | GC_METHOD_POST | Instance attribute | Public | Attribute reference (LIKE) | 20100302 | ||||
12 | GC_METHOD_PUT | Instance attribute | Public | Attribute reference (LIKE) | 20100302 |
Methods
Events
Interface IF_REST_REQUEST has no event.
Types
Interface IF_REST_REQUEST has no local type.
Method Signatures
Method GET_ENTITY Signature
Method GET_ENTITY on Interface IF_REST_REQUEST has no parameter.
Method GET_ENTITY on Interface IF_REST_REQUEST has no exception.
Method GET_HEADER_FIELD Signature
Method GET_HEADER_FIELD on Interface IF_REST_REQUEST has no parameter.
Method GET_HEADER_FIELD on Interface IF_REST_REQUEST has no exception.
Method GET_HEADER_FIELDS Signature
Method GET_HEADER_FIELDS on Interface IF_REST_REQUEST has no parameter.
Method GET_HEADER_FIELDS on Interface IF_REST_REQUEST has no exception.
Method GET_METHOD Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
RV_METHOD | Value transfer | Type reference (TYPE) | STRING | Request Method | 20100211 |
Method GET_METHOD on Interface IF_REST_REQUEST has no exception.
Method GET_URI Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
IV_ENCODED | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Return encoded URL? | 20100805 | |
2 | ![]() |
RV_REQUEST_URI | Value transfer | Type reference (TYPE) | STRING | Request URI | 20100218 |
Method GET_URI on Interface IF_REST_REQUEST has no exception.
Method GET_URI_ATTRIBUTE Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
IV_ENCODED | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Is Attribute Value URL encoded? | 20100719 | |
2 | ![]() |
IV_NAME | Call by reference | Type reference (TYPE) | STRING | Attribute Name | 20100218 | ||
3 | ![]() |
RV_VALUE | Value transfer | Type reference (TYPE) | STRING | Attribute Value | 20100218 |
Method GET_URI_ATTRIBUTE on Interface IF_REST_REQUEST has no exception.
Method GET_URI_ATTRIBUTES Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
IV_ENCODED | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Is Attribute Value URL encoded? | 20100719 | |
2 | ![]() |
RT_ATTRIBUTES | Value transfer | Type reference (TYPE) | TIHTTPNVP | List of Attributes | 20100218 |
Method GET_URI_ATTRIBUTES on Interface IF_REST_REQUEST has no exception.
Method GET_URI_FRAGMENT Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
RV_FRAGMENT | Value transfer | Type reference (TYPE) | STRING | URI Fragment | 20100218 |
Method GET_URI_FRAGMENT on Interface IF_REST_REQUEST has no exception.
Method GET_URI_MATRIX_PARAMETER Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
IV_NAME | Call by reference | Type reference (TYPE) | STRING | Matrix Parameter Name | 20100217 | ||
2 | ![]() |
RV_VALUE | Value transfer | Type reference (TYPE) | STRING | Matrix Parameter Value | 20100217 |
Method GET_URI_MATRIX_PARAMETER on Interface IF_REST_REQUEST has no exception.
Method GET_URI_MATRIX_PARAMETERS Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
RT_PARAMETERS | Value transfer | Type reference (TYPE) | TIHTTPNVP | List of Matrix Parameters (Name/Value) | 20100218 |
Method GET_URI_MATRIX_PARAMETERS on Interface IF_REST_REQUEST has no exception.
Method GET_URI_PATH Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
IV_ENCODED | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Return encoded URL? | 20100805 | |
2 | ![]() |
RV_REST_PATH | Value transfer | Type reference (TYPE) | STRING | REST Path of URI | 20100218 |
Method GET_URI_PATH on Interface IF_REST_REQUEST has no exception.
Method GET_URI_QUERY_PARAMETER Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
IV_ENCODED | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Is Attribute Value URL encoded? | 20100803 | |
2 | ![]() |
IV_NAME | Call by reference | Type reference (TYPE) | STRING | Query Parameter Name | 20100217 | ||
3 | ![]() |
RV_VALUE | Value transfer | Type reference (TYPE) | STRING | Query Parameter Value | 20100217 |
Method GET_URI_QUERY_PARAMETER on Interface IF_REST_REQUEST has no exception.
Method GET_URI_QUERY_PARAMETERS Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
IV_ENCODED | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Is Attribute Value URL encoded? | 20100803 | |
2 | ![]() |
IV_NAME | Call by reference | Type reference (TYPE) | STRING | Parameter Name | 20100614 | ||
3 | ![]() |
RT_PARAMETERS | Value transfer | Type reference (TYPE) | TIHTTPNVP | List of Query Parameters (Name/Value) | 20100218 |
Method GET_URI_QUERY_PARAMETERS on Interface IF_REST_REQUEST has no exception.
Method GET_URI_SEGMENTS Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
RT_SEGMENTS | Value transfer | Type reference (TYPE) | STRING_TABLE | List of Path Segments | 20100218 |
Method GET_URI_SEGMENTS on Interface IF_REST_REQUEST has no exception.
Method HAS_URI_QUERY_PARAMETER Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
IV_NAME | Call by reference | Type reference (TYPE) | STRING | Parameter Name | 20100618 | ||
2 | ![]() |
RV_CONTAINS_PARAMETER | Value transfer | Type reference (TYPE) | ABAP_BOOL | Exist Parameter | 20100618 |
Method HAS_URI_QUERY_PARAMETER on Interface IF_REST_REQUEST has no exception.
Method SET_URI_ATTRIBUTES Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ![]() |
IT_ATTRIBUTES | Call by reference | Type reference (TYPE) | TIHTTPNVP | List of Attributes | 20100218 |
Method SET_URI_ATTRIBUTES on Interface IF_REST_REQUEST has no exception.
History
Last changed by/on | SAP | 20130531 |
SAP Release Created in |