Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ServiceOrderItem" of service "API_SERVICE_ORDER_SRV". This service is part of the following communication scenarios: Service Order Integration (SAP_COM_0350). See https://api.sap.com/api/API_SERVICE_ORDER_SRV for more information.

Hierarchy

  • Entity
    • ServiceOrderItem

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns ServiceOrderItem

Properties

Protected _customFields

_customFields: MapType<any>

A mapper representing custom fields in an entity. Custom fields are represented by their field names and the corresponding values. A custom field can be added or updated using setCustomField method.

Protected _versionIdentifier

_versionIdentifier: string

The current ETag version of the entity in the remote system. The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. When no ETag is provided by the remote system the value of this variable defaults to "*".

Optional billToParty

billToParty: undefined | string

Bill-To Party. The 32 digit GUID for the bill-to party. Maximum length: 10.

nullable

Optional billableControl

billableControl: undefined | string

Accounting Indicator. Specifies the ID of an accounting indicator that enables you to control the following for products that you do not want fully bill for: PricingDifferentiation of actual costs in controllingIf you want to post costs in an integrated Controlling system using the accounting indicator as a key, you need to ensure that the accounting indicators that you create in this step are identical to the accounting indicators in the SAP system.For services performed in goodwill, you want to offer a discount of 50%. You also want to track costs for goodwill services in controlling. Maximum length: 2.

nullable

Optional executingServiceEmployee

executingServiceEmployee: undefined | string

Executing Service Employee. The 32-digit GUID for identifying a service employee. Maximum length: 10.

nullable

Optional language

language: undefined | string

Short Text Language for an Item. Maximum length: 2.

nullable

Optional parentServiceOrderItem

parentServiceOrderItem: undefined | string

Shortened Item Number in Document. Maximum length: 6.

nullable

Optional payerParty

payerParty: undefined | string

Payer. The 32-digit GUID that specifies the payer. Maximum length: 10.

nullable

Optional personResponsible

personResponsible: undefined | string

Employee Responsible. Maximum length: 10.

nullable

Optional plannedServiceEndDateTime

plannedServiceEndDateTime: Moment

Service Planned To Date.

nullable

Optional plannedServiceStartDateTime

plannedServiceStartDateTime: Moment

Service Planned From Date.

nullable

Optional product

product: undefined | string

Product Name Entered. Product that the customer originally ordered. If, for whatever reason, you have to deliver a substitute product for the one originally required, you can see which product the customer originally ordered. Maximum length: 54.

nullable

Optional quantity

quantity: BigNumber

CRM: Order Quantity. Total (rounded) order quantity in sales units of measure for this item. This field is only filled for a sales or opportunity item. This field remains empty for other item object types.

nullable

Optional quantityUnit

quantityUnit: undefined | string

Unit of Measure in Which the Product Is Sold. Unit of measure in which the product is sold. Maximum length: 3.

nullable

Optional referenceServiceContract

referenceServiceContract: undefined | string

Transaction ID. Number that identifies the transaction document. It is unique for each business transaction category. Maximum length: 10.

nullable

Optional referenceServiceContractItem

referenceServiceContractItem: undefined | string

Shortened Item Number in Document. Maximum length: 6.

nullable

Optional referenceServiceRequest

referenceServiceRequest: undefined | string

Transaction ID. Number that identifies the transaction document. It is unique for each business transaction category. Maximum length: 10.

nullable

Optional referenceServiceRequestItem

referenceServiceRequestItem: undefined | string

Shortened Item Number in Document. Maximum length: 6.

nullable

Protected remoteState

remoteState: object

The remote state of the entity. Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. It is stored as map, where the keys are stored in the format of VDM properties.

Type declaration

  • [keys: string]: any

Optional serviceDuration

serviceDuration: BigNumber

Duration. Estimated length of time required for the execution of a service.

nullable

Optional serviceDurationUnit

serviceDurationUnit: undefined | string

Unit for Duration of Work. Unit of time for the duration of a service. Maximum length: 3.

nullable

Optional serviceOrdItemRejectionReason

serviceOrdItemRejectionReason: undefined | string

Cancellation Reason Code. Reason for rejecting a sales transaction. The rejection can either come from your company, or from the customer (for example, the customer rejects a quotation because the price is too high).Enter a predefined value for your system. Maximum length: 2.

nullable

serviceOrder

serviceOrder: string

Transaction ID. Number that identifies the transaction document. It is unique for each business transaction category. Maximum length: 10.

serviceOrderItem

serviceOrderItem: string

Shortened Item Number in Document. Maximum length: 6.

Optional serviceOrderItemCategory

serviceOrderItemCategory: undefined | string

Item Category. Key that identifies an item category. An item category defines the characteristics and attributes of a transaction item and thus controls the processing of an item. Maximum length: 4.

nullable

Optional serviceOrderItemDescription

serviceOrderItemDescription: undefined | string

Product Description. Maximum length: 40.

nullable

Optional serviceOrderItemIsCompleted

serviceOrderItemIsCompleted: undefined | string

Service Order Item Is Completed. Maximum length: 1.

nullable

Optional serviceOrderItemIsRejected

serviceOrderItemIsRejected: undefined | string

Cancellation Status. Maximum length: 1.

nullable

Optional serviceOrderItemIsReleased

serviceOrderItemIsReleased: undefined | string

Release Status. Maximum length: 1.

nullable

Optional serviceOrderItemUuid

serviceOrderItemUuid: undefined | string

GUID of a CRM Order Object. The unique ID for an operation is a technical key by which the operation can be uniquely identified. This key is only used internally, and the operation number is always displayed on the interface. However, the operation number is not necessarily unique.

nullable

Optional shipToParty

shipToParty: undefined | string

Ship-To Party. Specifies the ship-to party as a 32-digit GUID. Maximum length: 10.

nullable

Optional soldToParty

soldToParty: undefined | string

Sold-To Party. The 32-digit GUID used to identify the sold-to party. Maximum length: 10.

nullable

Optional timeSheetOvertimeCategory

timeSheetOvertimeCategory: undefined | string

Overtime Category. Overtime is defined as the time an employee works outside the regular working times. Overtime Category is the classification of the overtime hours. It is used in the Manage My Timesheet app to efficiently create time entries. Maximum length: 4.

nullable

toConfirmation

One-to-many navigation property to the ServiceOrderItemConfirmation entity.

toPricingElement

toPricingElement: ServiceOrderItemPriceElement[]

One-to-many navigation property to the ServiceOrderItemPriceElement entity.

toReferenceObject

toReferenceObject: ServiceOrderItemRefObject[]

One-to-many navigation property to the ServiceOrderItemRefObject entity.

toText

One-to-many navigation property to the ServiceOrderItemText entity.

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

The ETag version identifier of the retrieved entity, returns undefined if not retrieved

Static ALL_FIELDS

ALL_FIELDS: AllFields<ServiceOrderItem> = new AllFields('*', ServiceOrderItem)

All fields selector.

Static BILLABLE_CONTROL

BILLABLE_CONTROL: StringField<ServiceOrderItem> = new StringField('BillableControl', ServiceOrderItem, 'Edm.String')

Static representation of the billableControl property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static BILL_TO_PARTY

BILL_TO_PARTY: StringField<ServiceOrderItem> = new StringField('BillToParty', ServiceOrderItem, 'Edm.String')

Static representation of the billToParty property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static EXECUTING_SERVICE_EMPLOYEE

EXECUTING_SERVICE_EMPLOYEE: StringField<ServiceOrderItem> = new StringField('ExecutingServiceEmployee', ServiceOrderItem, 'Edm.String')

Static representation of the executingServiceEmployee property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static LANGUAGE

LANGUAGE: StringField<ServiceOrderItem> = new StringField('Language', ServiceOrderItem, 'Edm.String')

Static representation of the language property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PARENT_SERVICE_ORDER_ITEM

PARENT_SERVICE_ORDER_ITEM: StringField<ServiceOrderItem> = new StringField('ParentServiceOrderItem', ServiceOrderItem, 'Edm.String')

Static representation of the parentServiceOrderItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PAYER_PARTY

PAYER_PARTY: StringField<ServiceOrderItem> = new StringField('PayerParty', ServiceOrderItem, 'Edm.String')

Static representation of the payerParty property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PERSON_RESPONSIBLE

PERSON_RESPONSIBLE: StringField<ServiceOrderItem> = new StringField('PersonResponsible', ServiceOrderItem, 'Edm.String')

Static representation of the personResponsible property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PLANNED_SERVICE_END_DATE_TIME

PLANNED_SERVICE_END_DATE_TIME: DateField<ServiceOrderItem> = new DateField('PlannedServiceEndDateTime', ServiceOrderItem, 'Edm.DateTimeOffset')

Static representation of the plannedServiceEndDateTime property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PLANNED_SERVICE_START_DATE_TIME

PLANNED_SERVICE_START_DATE_TIME: DateField<ServiceOrderItem> = new DateField('PlannedServiceStartDateTime', ServiceOrderItem, 'Edm.DateTimeOffset')

Static representation of the plannedServiceStartDateTime property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PRODUCT

PRODUCT: StringField<ServiceOrderItem> = new StringField('Product', ServiceOrderItem, 'Edm.String')

Static representation of the product property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static QUANTITY

QUANTITY: BigNumberField<ServiceOrderItem> = new BigNumberField('Quantity', ServiceOrderItem, 'Edm.Decimal')

Static representation of the quantity property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static QUANTITY_UNIT

QUANTITY_UNIT: StringField<ServiceOrderItem> = new StringField('QuantityUnit', ServiceOrderItem, 'Edm.String')

Static representation of the quantityUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static REFERENCE_SERVICE_CONTRACT

REFERENCE_SERVICE_CONTRACT: StringField<ServiceOrderItem> = new StringField('ReferenceServiceContract', ServiceOrderItem, 'Edm.String')

Static representation of the referenceServiceContract property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static REFERENCE_SERVICE_CONTRACT_ITEM

REFERENCE_SERVICE_CONTRACT_ITEM: StringField<ServiceOrderItem> = new StringField('ReferenceServiceContractItem', ServiceOrderItem, 'Edm.String')

Static representation of the referenceServiceContractItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static REFERENCE_SERVICE_REQUEST

REFERENCE_SERVICE_REQUEST: StringField<ServiceOrderItem> = new StringField('ReferenceServiceRequest', ServiceOrderItem, 'Edm.String')

Static representation of the referenceServiceRequest property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static REFERENCE_SERVICE_REQUEST_ITEM

REFERENCE_SERVICE_REQUEST_ITEM: StringField<ServiceOrderItem> = new StringField('ReferenceServiceRequestItem', ServiceOrderItem, 'Edm.String')

Static representation of the referenceServiceRequestItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SERVICE_DURATION

SERVICE_DURATION: BigNumberField<ServiceOrderItem> = new BigNumberField('ServiceDuration', ServiceOrderItem, 'Edm.Decimal')

Static representation of the serviceDuration property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SERVICE_DURATION_UNIT

SERVICE_DURATION_UNIT: StringField<ServiceOrderItem> = new StringField('ServiceDurationUnit', ServiceOrderItem, 'Edm.String')

Static representation of the serviceDurationUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SERVICE_ORDER

SERVICE_ORDER: StringField<ServiceOrderItem> = new StringField('ServiceOrder', ServiceOrderItem, 'Edm.String')

Static representation of the serviceOrder property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SERVICE_ORDER_ITEM

SERVICE_ORDER_ITEM: StringField<ServiceOrderItem> = new StringField('ServiceOrderItem', ServiceOrderItem, 'Edm.String')

Static representation of the serviceOrderItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SERVICE_ORDER_ITEM_CATEGORY

SERVICE_ORDER_ITEM_CATEGORY: StringField<ServiceOrderItem> = new StringField('ServiceOrderItemCategory', ServiceOrderItem, 'Edm.String')

Static representation of the serviceOrderItemCategory property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SERVICE_ORDER_ITEM_DESCRIPTION

SERVICE_ORDER_ITEM_DESCRIPTION: StringField<ServiceOrderItem> = new StringField('ServiceOrderItemDescription', ServiceOrderItem, 'Edm.String')

Static representation of the serviceOrderItemDescription property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SERVICE_ORDER_ITEM_IS_COMPLETED

SERVICE_ORDER_ITEM_IS_COMPLETED: StringField<ServiceOrderItem> = new StringField('ServiceOrderItemIsCompleted', ServiceOrderItem, 'Edm.String')

Static representation of the serviceOrderItemIsCompleted property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SERVICE_ORDER_ITEM_IS_REJECTED

SERVICE_ORDER_ITEM_IS_REJECTED: StringField<ServiceOrderItem> = new StringField('ServiceOrderItemIsRejected', ServiceOrderItem, 'Edm.String')

Static representation of the serviceOrderItemIsRejected property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SERVICE_ORDER_ITEM_IS_RELEASED

SERVICE_ORDER_ITEM_IS_RELEASED: StringField<ServiceOrderItem> = new StringField('ServiceOrderItemIsReleased', ServiceOrderItem, 'Edm.String')

Static representation of the serviceOrderItemIsReleased property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SERVICE_ORDER_ITEM_UUID

SERVICE_ORDER_ITEM_UUID: StringField<ServiceOrderItem> = new StringField('ServiceOrderItemUUID', ServiceOrderItem, 'Edm.Guid')

Static representation of the serviceOrderItemUuid property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SERVICE_ORD_ITEM_REJECTION_REASON

SERVICE_ORD_ITEM_REJECTION_REASON: StringField<ServiceOrderItem> = new StringField('ServiceOrdItemRejectionReason', ServiceOrderItem, 'Edm.String')

Static representation of the serviceOrdItemRejectionReason property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SHIP_TO_PARTY

SHIP_TO_PARTY: StringField<ServiceOrderItem> = new StringField('ShipToParty', ServiceOrderItem, 'Edm.String')

Static representation of the shipToParty property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SOLD_TO_PARTY

SOLD_TO_PARTY: StringField<ServiceOrderItem> = new StringField('SoldToParty', ServiceOrderItem, 'Edm.String')

Static representation of the soldToParty property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TIME_SHEET_OVERTIME_CATEGORY

TIME_SHEET_OVERTIME_CATEGORY: StringField<ServiceOrderItem> = new StringField('TimeSheetOvertimeCategory', ServiceOrderItem, 'Edm.String')

Static representation of the timeSheetOvertimeCategory property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_CONFIRMATION

TO_CONFIRMATION: Link<ServiceOrderItem, ServiceOrderItemConfirmation> = new Link('to_Confirmation', ServiceOrderItem, ServiceOrderItemConfirmation)

Static representation of the one-to-many navigation property toConfirmation for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_PRICING_ELEMENT

TO_PRICING_ELEMENT: Link<ServiceOrderItem, ServiceOrderItemPriceElement> = new Link('to_PricingElement', ServiceOrderItem, ServiceOrderItemPriceElement)

Static representation of the one-to-many navigation property toPricingElement for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_REFERENCE_OBJECT

TO_REFERENCE_OBJECT: Link<ServiceOrderItem, ServiceOrderItemRefObject> = new Link('to_ReferenceObject', ServiceOrderItem, ServiceOrderItemRefObject)

Static representation of the one-to-many navigation property toReferenceObject for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_TEXT

TO_TEXT: Link<ServiceOrderItem, ServiceOrderItemText> = new Link('to_Text', ServiceOrderItem, ServiceOrderItemText)

Static representation of the one-to-many navigation property toText for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static _allFields

_allFields: Array<StringField<ServiceOrderItem> | BigNumberField<ServiceOrderItem> | DateField<ServiceOrderItem> | Link<ServiceOrderItem, ServiceOrderItemConfirmation> | Link<ServiceOrderItem, ServiceOrderItemPriceElement> | Link<ServiceOrderItem, ServiceOrderItemRefObject> | Link<ServiceOrderItem, ServiceOrderItemText>> = [ServiceOrderItem.SERVICE_ORDER,ServiceOrderItem.SERVICE_ORDER_ITEM,ServiceOrderItem.SERVICE_ORDER_ITEM_UUID,ServiceOrderItem.SERVICE_ORDER_ITEM_DESCRIPTION,ServiceOrderItem.LANGUAGE,ServiceOrderItem.PRODUCT,ServiceOrderItem.QUANTITY,ServiceOrderItem.QUANTITY_UNIT,ServiceOrderItem.SERVICE_DURATION,ServiceOrderItem.SERVICE_DURATION_UNIT,ServiceOrderItem.SERVICE_ORDER_ITEM_CATEGORY,ServiceOrderItem.SERVICE_ORD_ITEM_REJECTION_REASON,ServiceOrderItem.BILLABLE_CONTROL,ServiceOrderItem.SOLD_TO_PARTY,ServiceOrderItem.SHIP_TO_PARTY,ServiceOrderItem.BILL_TO_PARTY,ServiceOrderItem.PAYER_PARTY,ServiceOrderItem.PERSON_RESPONSIBLE,ServiceOrderItem.EXECUTING_SERVICE_EMPLOYEE,ServiceOrderItem.SERVICE_ORDER_ITEM_IS_RELEASED,ServiceOrderItem.SERVICE_ORDER_ITEM_IS_COMPLETED,ServiceOrderItem.SERVICE_ORDER_ITEM_IS_REJECTED,ServiceOrderItem.REFERENCE_SERVICE_CONTRACT,ServiceOrderItem.REFERENCE_SERVICE_CONTRACT_ITEM,ServiceOrderItem.REFERENCE_SERVICE_REQUEST,ServiceOrderItem.REFERENCE_SERVICE_REQUEST_ITEM,ServiceOrderItem.TIME_SHEET_OVERTIME_CATEGORY,ServiceOrderItem.PARENT_SERVICE_ORDER_ITEM,ServiceOrderItem.PLANNED_SERVICE_START_DATE_TIME,ServiceOrderItem.PLANNED_SERVICE_END_DATE_TIME,ServiceOrderItem.TO_CONFIRMATION,ServiceOrderItem.TO_PRICING_ELEMENT,ServiceOrderItem.TO_REFERENCE_OBJECT,ServiceOrderItem.TO_TEXT]

All fields of the ServiceOrderItem entity.

Static _defaultServicePath

_defaultServicePath: string = "/sap/opu/odata/sap/API_SERVICE_ORDER_SRV"

Default url path for the according service.

Static _entityName

_entityName: string = "A_ServiceOrderItem"

Technical entity name for ServiceOrderItem.

Static _keyFields

_keyFields: Array<Selectable<ServiceOrderItem>> = [ServiceOrderItem.SERVICE_ORDER, ServiceOrderItem.SERVICE_ORDER_ITEM]

All key fields of the ServiceOrderItem entity.

Static _keys

_keys: object = ServiceOrderItem._keyFields.reduce((acc: { [keys: string]: Selectable<ServiceOrderItem> }, field: Selectable<ServiceOrderItem>) => {acc[field.fieldName] = field;return acc;}, {})

Mapping of all key field names to the respective static field property ServiceOrderItem.

Type declaration

Static _serviceName

_serviceName: string = "API_SERVICE_ORDER_SRV"
deprecated

Since v1.0.1 Use _defaultServicePath instead. Technical service name for ServiceOrderItem.

Methods

Protected getCurrentMapKeys

  • getCurrentMapKeys(): Entity
  • Returns a map of all defined fields in entity to their current values.

    Returns Entity

    Entity with all defined entity fields

getCustomField

  • getCustomField(fieldName: string): any
  • Custom field value getter.

    Parameters

    • fieldName: string

      The name of the custom field

    Returns any

    The value of the corresponding custom field

getCustomFields

  • getCustomFields(): MapType<any>
  • Returns a map that contains all entity custom fields.

    Returns MapType<any>

    A map of all defined custom fields in the entity

getUpdatedCustomFields

  • getUpdatedCustomFields(): MapType<any>
  • Returns all updated custom field properties compared to the last known remote state.

    Returns MapType<any>

    A map containing all updated custom properties, with their new values

getUpdatedProperties

  • getUpdatedProperties(): Entity
  • Returns all changed properties compared to the last known remote state. The returned properties does not include custom fields. Use getUpdatedCustomFields, if updated custom fields are needed.

    Returns Entity

    Entity with all properties that changed

hasCustomField

  • hasCustomField(fieldName: string): boolean
  • Validates whether a custom field exists in the entity.

    Parameters

    • fieldName: string

      The name of the custom field to update

    Returns boolean

    A boolean value, that indicates whether a custom field is defined in entity

initializeCustomFields

  • initializeCustomFields(customFields: MapType<any>): this
  • Sets all retrieved custom fields in entity.

    Parameters

    • customFields: MapType<any>

      Extracted custom fields from a retrieved entity

    Returns this

    A boolean value, that indicates the existence of the field in entity

Protected isConflictingCustomField

  • isConflictingCustomField(customFieldName: string): boolean
  • Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.

    Parameters

    • customFieldName: string

      Field name to check

    Returns boolean

    Boolean value that describes whether a field name can be defined as custom field

setCustomField

  • setCustomField(fieldName: string, value: any): this
  • Sets a new custom field in the entity or updates it. Throws an error, if the provided custom field name is already defined by an original field in entity.

    Parameters

    • fieldName: string

      The name of the custom field to update

    • value: any

      The value of the field

    Returns this

    The entity itself, to facilitate method chaining

setOrInitializeRemoteState

  • setOrInitializeRemoteState(state?: MapType<any>): this
  • Initializes or sets the remoteState of the entity. This function is called on all read, create and update requests. This function should be called after initializeCustomFields, if custom fields are defined.

    deprecated

    Since 1.12.0. Will be removed in version 2.0.

    Parameters

    • Optional state: MapType<any>

      State to be set as remote state

    Returns this

    The entity itself, to facilitate method chaining

setVersionIdentifier

  • setVersionIdentifier(etag: string | undefined): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string | undefined

      The returned ETag version of the entity

    Returns this

    The entity itself, to facilitate method chaining

toJSON

  • toJSON(): object
  • Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.

    Returns object

    An object containing all instance variables + custom fields.

    • [key: string]: any

Static builder

Static customField

  • Returns a selectable object that allows the selection of custom field in a get request for the entity ServiceOrderItem.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ServiceOrderItem>

    A builder that constructs instances of entity type ServiceOrderItem.

Static Protected customFieldSelector

  • customFieldSelector<EntityT>(fieldName: string, entityConstructor: Constructable<EntityT>): CustomField<EntityT>
  • Type parameters

    • EntityT: Entity

    Parameters

    • fieldName: string
    • entityConstructor: Constructable<EntityT>

    Returns CustomField<EntityT>

Static Protected entityBuilder

  • entityBuilder<EntityT, EntityTypeForceMandatoryT>(entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>): EntityBuilderType<EntityT, EntityTypeForceMandatoryT>
  • Type parameters

    • EntityT: Entity

    • EntityTypeForceMandatoryT

    Parameters

    • entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>

    Returns EntityBuilderType<EntityT, EntityTypeForceMandatoryT>

Static requestBuilder

  • Returns a request builder to construct requests for operations on the ServiceOrderItem entity type.

    Returns ServiceOrderItemRequestBuilder

    A ServiceOrderItem request builder.