ODataV4 | @odata/client

Hierarchy

ODataV4

Index

Methods

execBatchRequests

execBatchRequests<T>(requests: T): BatchResponsesV4<T>

- Defined in build/repo/src/types_v4.ts:125
execute batch requests and get response

Type parameters
- T: Promise<BatchRequestV4<any>>[] = any
Parameters
- requests: T
  
  batch request
Returns BatchResponsesV4<T>

execBatchRequestsJson

execBatchRequestsJson<T>(requests: T): BatchResponsesV4<T>

- Defined in build/repo/src/types_v4.ts:133
execute batch requests in OData V4.01 JSON format, and get the response

Type parameters
- T: Promise<BatchRequestV4<any>>[] = any
Parameters
- requests: T
Returns BatchResponsesV4<T>

getEntitySet

getEntitySet<T>(entitySetName: string): EntitySet<T>

- Defined in build/repo/src/types_v4.ts:67
get Entity Set by entityset name

Type parameters
- T = any
Parameters
- entitySetName: string
  
  the name of entity set, you can get it from metadata
Returns EntitySet<T>

getVersion

getVersion(): ODataVersion

- Defined in build/repo/src/types_v4.ts:86
get odata version

Returns ODataVersion

newBatchRequest

newBatchRequest<T>(options: BatchRequestOptionsV4<T>): Promise<BatchRequestV4<any>>

- Defined in build/repo/src/types_v4.ts:117
create batch request (will not perform)

Type parameters
- T
Parameters
- options: BatchRequestOptionsV4<T>
Returns Promise<BatchRequestV4<any>>

newFilter

newFilter(): ODataFilter<any>

- Defined in build/repo/src/types_v4.ts:102
create new filter

alias

OData.newFilter

Returns ODataFilter<any>

newParam

newParam(): ODataQueryParam<any>

- Defined in build/repo/src/types_v4.ts:109
create new param

alias

OData.newParam

Returns ODataQueryParam<any>

newRequest

newRequest<T>(options: ODataQueryRequest<T>): Promise<PlainODataMultiResponseV4<T>>
newRequest<T>(options: ODataWriteRequest<T>): Promise<PlainODataSingleResponseV4<T>>
newRequest<T>(options: ODataReadIDRequest<T>): Promise<PlainODataSingleResponseV4<T>>
newRequest(options: ODataFunctionRequest): Promise<PlainODataResponseV4>
newRequest(options: ODataActionRequest): Promise<PlainODataResponseV4>

- Defined in build/repo/src/types_v4.ts:91
new odata http request

Type parameters
- T
Parameters
- options: ODataQueryRequest<T>
Returns Promise<PlainODataMultiResponseV4<T>>
- Defined in build/repo/src/types_v4.ts:92
Type parameters
- T
Parameters
- options: ODataWriteRequest<T>
Returns Promise<PlainODataSingleResponseV4<T>>
- Defined in build/repo/src/types_v4.ts:93
Type parameters
- T
Parameters
- options: ODataReadIDRequest<T>
Returns Promise<PlainODataSingleResponseV4<T>>
- Defined in build/repo/src/types_v4.ts:94
Parameters
- options: ODataFunctionRequest
Returns Promise<PlainODataResponseV4>
- Defined in build/repo/src/types_v4.ts:95
Parameters
- options: ODataActionRequest
Returns Promise<PlainODataResponseV4>

setCredential

setCredential(credential: Credential): void

- Defined in build/repo/src/types_v4.ts:74
Set OData Client Http Basic credential

Parameters
- credential: Credential
Returns void

setODataEndPath

setODataEndPath(odataEnd: string): void

- Defined in build/repo/src/types_v4.ts:81
setODataEndPath

e.g. https://tenant.c4c.saphybriscloud.cn/sap/c4c/odata/v1/c4codata/

Parameters
- odataEnd: string
Returns void

Hierarchy

Index

Methods

Methods

execBatchRequests

Type parameters

T: Promise<BatchRequestV4<any>>[] = any

Parameters

requests: T

Returns BatchResponsesV4<T>

execBatchRequestsJson

Type parameters

T: Promise<BatchRequestV4<any>>[] = any

Parameters

requests: T

Returns BatchResponsesV4<T>

getEntitySet

Type parameters

T = any

Parameters

entitySetName: string

Returns EntitySet<T>

getVersion

Returns ODataVersion

newBatchRequest

Type parameters

T

Parameters

options: BatchRequestOptionsV4<T>

Returns Promise<BatchRequestV4<any>>

newFilter

Returns ODataFilter<any>

newParam

Returns ODataQueryParam<any>

newRequest

Type parameters

T

Parameters

options: ODataQueryRequest<T>

Returns Promise<PlainODataMultiResponseV4<T>>

Type parameters

T

Parameters

options: ODataWriteRequest<T>

Returns Promise<PlainODataSingleResponseV4<T>>

Type parameters

T

Parameters

options: ODataReadIDRequest<T>

Returns Promise<PlainODataSingleResponseV4<T>>

Parameters

options: ODataFunctionRequest

Returns Promise<PlainODataResponseV4>

Parameters

options: ODataActionRequest

Returns Promise<PlainODataResponseV4>

setCredential

Parameters

credential: Credential

Returns void

setODataEndPath

Parameters

odataEnd: string

Returns void