Class OData

OData Client

Constructors

`Private` constructor

new OData(serviceEndpoint, credential?, headers?, fetchProxy?, processCsrfToken?): OData
Private
OData
Parameters
- serviceEndpoint: string
- Optional credential: Credential
- headers: any = {}
- Optional fetchProxy: FetchProxy
- processCsrfToken: boolean = false
  auto fetch csrf token before broken operation
Returns OData
Deprecated
please use static method OData.New to create instance
- Defined in odata.ts:149

Properties

`Private` commonHeader

commonHeader: {
[headerName: string]: string;
} = DEFULAT_HEADERS

dont direct use this object

use client.getHeaders()

Type declaration

[headerName: string]: string

`Private` credential

credential: Credential

http basic credential

`Private` csrfToken

csrfToken: string = ""

internal csrf token

`Private` csrfTokenName

csrfTokenName: string = S_X_CSRF_TOKEN

`Private` fetchProxy

fetchProxy: FetchProxy = defaultProxy

`Private` lock

lock: Mutex = ...

`Private` oauthClient

oauthClient: ClientCredentialsOAuthClient

oauth client for client credential flow

`Private` processCsrfToken

processCsrfToken: boolean = false

`Private` serviceEndpoint

serviceEndpoint: string

odata service path, like /sap/c4c/odata/v1/c4codata/

`Private` variant

variant: ODataVariant = "default"

`Private` version

version: ODataVersion = "v2"

Methods

`Private` _executeActionOrFunction

_executeActionOrFunction(options): any
Parameters
- options: ODataActionRequest
Returns any
- Defined in odata.ts:424
_executeActionOrFunction(options): any
Parameters
- options: ODataFunctionRequest
Returns any
- Defined in odata.ts:426
_executeActionOrFunction(options): any
Parameters
- options: ODataFunctionImportRequest
Returns any
- Defined in odata.ts:428
_executeActionOrFunction(options): any
Parameters
- options: ODataActionImportRequest
Returns any
- Defined in odata.ts:430

`Private` _executeDataOperation

_executeDataOperation<T>(collection, id?, systemOptions?, method?, entity?): Promise<PlainODataMultiResponse<T>>
odata request
Type Parameters
- T = any
Parameters
- collection: string
  CollectionName
- Optional id: any
  entity uuid or compound key
- Optional systemOptions: SystemQueryOptions<any>
  query param, not work for single entity uri
- method: HTTPMethod = "GET"
  request method
- Optional entity: any
  odata Entity instance
Returns Promise<PlainODataMultiResponse<T>>
- Defined in odata.ts:346

actionImport

actionImport(actionName, parameters?, params?): Promise<PlainODataResponse>
Parameters
- actionName: string
- Optional parameters: any
- params: SystemQueryOptions<any> = ...
Returns Promise<PlainODataResponse>
- Defined in odata.ts:364

cleanCsrfToken

cleanCsrfToken(): void
Returns void
- Defined in odata.ts:290

execBatchRequests

execBatchRequests(requests): BatchResponses<BatchRequests>
execute batch requests and get response
Parameters
- requests: BatchRequests
  batch request
Returns BatchResponses<BatchRequests>
- Defined in odata.ts:542

execBatchRequestsJson

execBatchRequestsJson<T>(requests): BatchResponses<T>
Experimental
execute batch requests in OData V4.01 Json format, and get response

this feature is experimental, use it on your own risk.
Type Parameters
- T extends BatchRequests = any
Parameters
- requests: T
Returns BatchResponses<T>
- Defined in odata.ts:561

`Private` formatBatchRequests

formatBatchRequests(requests): Promise<{
req: RequestInit;
url: string;
}>
format batch request parameter
Parameters
- requests: Promise<BatchRequest<any>>[]
Returns Promise<{
req: RequestInit;
url: string;
}>
- Defined in odata.ts:521

`Private` formatIdString

formatIdString(key): string
convert the odata key predicate object/value to string
Parameters
- key: ODataKeyPredicate
Returns string
Example
```
this.formatIdString(1) // => String('(1)')
this.formatIdString({UUID:'xxx'}) // => String('(UUID='xxx')')
```
- Defined in odata.ts:395

functionImport

functionImport(functionName, parameters?, params?): Promise<PlainODataResponse>
Parameters
- functionName: string
- Optional parameters: any
- params: SystemQueryOptions<any> = ...
Returns Promise<PlainODataResponse>
- Defined in odata.ts:373

getCsrfToken

getCsrfToken(withCache?): Promise<string>
fetch CSRF Token
Parameters
- withCache: boolean = true
  set to false if you want to force to retrieve the refresh csrf token
Returns Promise<string>
- Defined in odata.ts:261

getEntitySet

getEntitySet<T>(entitySetName): EntitySet<T>
getEntitySet
Type Parameters
- T = any
Parameters
- entitySetName: string
  the name of entity set, you can get it from metadata
Returns EntitySet<T>
- Defined in odata.ts:224

`Private` getHeaders

getHeaders(): Promise<{}>
generate dynamic header

Returns Promise<{}>
- Defined in odata.ts:195

getVersion

getVersion(): ODataVersion
Returns ODataVersion
- Defined in odata.ts:251

newBatchRequest

newBatchRequest<T>(options): Promise<BatchRequest<T>>
Type Parameters
- T
Parameters
- options: BatchRequestOptions<T>
Returns Promise<BatchRequest<T>>
- Defined in odata.ts:623

newFilter

newFilter<T>(): ODataFilter<any>
create new filter
Type Parameters
- T = any
Returns ODataFilter<any>
Alias
OData.newFilter
- Defined in odata.ts:596

newOptions

newOptions<T>(): SystemQueryOptions<T>
create new system query options
Type Parameters
- T = any
Returns SystemQueryOptions<T>
- Defined in odata.ts:615

newParam

newParam<T>(): SystemQueryOptions<any>
create new system query options
Type Parameters
- T = any
Returns SystemQueryOptions<any>
Deprecated
Alias
OData.newParam
- Defined in odata.ts:606

newRequest

newRequest<T>(options): Promise<PlainODataMultiResponse<T>>
new odata http request
Type Parameters
- T = any
Parameters
- options: ODataQueryRequest
Returns Promise<PlainODataMultiResponse<T>>
- Defined in odata.ts:402
newRequest<T>(options): Promise<PlainODataSingleResponse<T>>
Type Parameters
- T = any
Parameters
- options: ODataWriteRequest<T>
Returns Promise<PlainODataSingleResponse<T>>
- Defined in odata.ts:404
newRequest<T>(options): Promise<PlainODataSingleResponse<T>>
Type Parameters
- T = any
Parameters
- options: ODataReadIDRequest
Returns Promise<PlainODataSingleResponse<T>>
- Defined in odata.ts:406
newRequest(options): Promise<PlainODataResponse>
Parameters
- options: ODataFunctionRequest
Returns Promise<PlainODataResponse>
- Defined in odata.ts:408
newRequest(options): Promise<PlainODataResponse>
Parameters
- options: ODataActionRequest
Returns Promise<PlainODataResponse>
- Defined in odata.ts:410
newRequest(options): Promise<PlainODataResponse>
Parameters
- options: ODataFunctionImportRequest
Returns Promise<PlainODataResponse>
- Defined in odata.ts:412
newRequest(options): Promise<PlainODataResponse>
Parameters
- options: ODataActionImportRequest
Returns Promise<PlainODataResponse>
- Defined in odata.ts:414

newTransformation

newTransformation(): Transformation
Returns Transformation
- Defined in odata.ts:619

`Private` requestUri

requestUri<T>(uri, systemOptions?, method?, body?): Promise<PlainODataMultiResponse<T>>
odata request uri
Type Parameters
- T = any
Parameters
- uri: string
  HTTP URI
- Optional systemOptions: SystemQueryOptions<any>
  odata query params
- method: HTTPMethod = "GET"
  HTTP method
- Optional body: any
  request content
Returns Promise<PlainODataMultiResponse<T>>
- Defined in odata.ts:302

setCredential

setCredential(credential): void
Set OData Client Http Basic credential
Parameters
- credential: Credential
Returns void
- Defined in odata.ts:233

setODataEndPath

setODataEndPath(odataEndpoint): void
setODataEndPath

e.g. https://tenant.c4c.saphybriscloud.cn/sap/c4c/odata/v1/c4codata/
Parameters
- odataEndpoint: string
Returns void
- Defined in odata.ts:242

`Static` New

New(options): ODataV4
OData client builder
Parameters
- options: ODataV4NewOptions
  config options
Returns ODataV4
- Defined in odata.ts:75
New(options): OData
Parameters
- options: ODataNewOptions
Returns OData
- Defined in odata.ts:77

`Static` New4

New4(options): ODataV4
create odata client instance for odata v4
Parameters
- options: ODataNewOptions
Returns ODataV4
- Defined in odata.ts:105

`Static` newFilter

newFilter<T>(): ODataFilter<any>
new filter
Type Parameters
- T = any
Returns ODataFilter<any>
- Defined in odata.ts:130

`Static` newOptions

newOptions<T>(): SystemQueryOptions<T>
new odata query options
Type Parameters
- T = any
Returns SystemQueryOptions<T>
- Defined in odata.ts:123

`Static` newParam

newParam<T>(): SystemQueryOptions<any>
new odata query options
Type Parameters
- T = any
Returns SystemQueryOptions<any>
Deprecated
- Defined in odata.ts:116

`Static` newTransformation

newTransformation(): Transformation
new transformation

Returns Transformation
- Defined in odata.ts:139

Class OData

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

serviceEndpoint: string

Optional credential: Credential

headers: any = {}

Optional fetchProxy: FetchProxy

processCsrfToken: boolean = false

Returns OData

Deprecated

Properties

Private commonHeader

Type declaration

[headerName: string]: string

Private credential

Private csrfToken

Private csrfTokenName

Private fetchProxy

Private lock

Private oauthClient

Private processCsrfToken

Private serviceEndpoint

Private variant

Private version

Methods

Private _executeActionOrFunction

Parameters

options: ODataActionRequest

Returns any

Parameters

options: ODataFunctionRequest

Returns any

Parameters

options: ODataFunctionImportRequest

Returns any

Parameters

options: ODataActionImportRequest

Returns any

Private _executeDataOperation

Type Parameters

T = any

Parameters

collection: string

Optional id: any

Optional systemOptions: SystemQueryOptions<any>

method: HTTPMethod = "GET"

Optional entity: any

Returns Promise<PlainODataMultiResponse<T>>

actionImport

Parameters

actionName: string

Optional parameters: any

params: SystemQueryOptions<any> = ...

Returns Promise<PlainODataResponse>

cleanCsrfToken

Returns void

execBatchRequests

Parameters

requests: BatchRequests

Returns BatchResponses<BatchRequests>

execBatchRequestsJson

Type Parameters

T extends BatchRequests = any

Parameters

requests: T

Returns BatchResponses<T>

Private formatBatchRequests

Parameters

requests: Promise<BatchRequest<any>>[]

Returns Promise<{ req: RequestInit; url: string; }>

Private formatIdString

Parameters

key: ODataKeyPredicate

Returns string

Example

`Private` constructor

`Optional` credential: Credential

`Optional` fetchProxy: FetchProxy

`Private` commonHeader

`Private` credential

`Private` csrfToken

`Private` csrfTokenName

`Private` fetchProxy

`Private` lock

`Private` oauthClient

`Private` processCsrfToken

`Private` serviceEndpoint

`Private` variant

`Private` version

`Private` _executeActionOrFunction

`Private` _executeDataOperation

`Optional` id: any

`Optional` systemOptions: SystemQueryOptions<any>

`Optional` entity: any

`Optional` parameters: any

`Private` formatBatchRequests

Returns Promise<{
req: RequestInit;
url: string;
}>

`Private` formatIdString

`Optional` parameters: any

`Private` getHeaders