Codeunit "Web Service Management"

ID 9750

Namespace: System.Integration

Provides methods for creating and modifying web services, accessing web service URLs, and getting and setting web service filters and clauses.

Properties

Name	Value
Access	Public

Methods

CreateTenantWebService

Creates a tenant web service for a given object. If the tenant web service already exists, it modifies the tenant web service accordingly.

procedure CreateTenantWebService(ObjectType: Option, ObjectId: Integer, ObjectName: Text, Published: Boolean)

Parameters

Name	Type	Description
ObjectType	Option	The type of the object.
ObjectId	Integer	The ID of the object.
ObjectName	Text	The name of the object.
Published	Boolean	Indicates whether the web service is published or not.

GetWebServiceUrl

Gets the web service URL for a given Web Service Aggregate record and client type.

procedure GetWebServiceUrl(WebServiceAggregate: Record "Web Service Aggregate", ClientType: Enum "Client Type"): Text

Parameters

Name	Type	Description
WebServiceAggregate	Record "Web Service Aggregate"	The record for getting web service URL.
ClientType	System.Integration."Client Type"	The client type of the URL. Clients are SOAP, ODataV3 and ODataV4.

Returns

Type	Description
Text	Web service URL for the given record.

CreateTenantWebServiceColumnsFromTemp

Creates tenant web service columns from temporary records.

procedure CreateTenantWebServiceColumnsFromTemp(var TenantWebServiceColumns: Record "Tenant Web Service Columns", var TempTenantWebServiceColumns: Record "Tenant Web Service Columns" temporary, TenantWebServiceRecordId: RecordId)

Parameters

Name	Type	Description
TenantWebServiceColumns	Record "Tenant Web Service Columns"	Record that the columns from temporary records are inserted to.
TempTenantWebServiceColumns	Record "Tenant Web Service Columns" temporary	Temporary record that the columns are inserted from.
TenantWebServiceRecordId	RecordId	The ID of the Tenant Web Service corresponding to columns.

CreateTenantWebServiceFilterFromRecordRef

Creates a tenant web service filter from a record reference.

procedure CreateTenantWebServiceFilterFromRecordRef(var TenantWebServiceFilter: Record "Tenant Web Service Filter", var RecordRef: RecordRef, TenantWebServiceRecordId: RecordId)

Parameters

Name	Type	Description
TenantWebServiceFilter	Record "Tenant Web Service Filter"	Record that the filter from record reference is inserted to.
RecordRef	RecordRef	Record reference that the filter is inserted from.
TenantWebServiceRecordId	RecordId	The ID of the Tenant Web Service corresponding to the filter.

GetTenantWebServiceFilter

Returns the tenant web service filter for a given record.

procedure GetTenantWebServiceFilter(TenantWebServiceFilter: Record "Tenant Web Service Filter"): Text

Parameters

Name	Type	Description
TenantWebServiceFilter	Record "Tenant Web Service Filter"	The record for getting filter.

Returns

Type	Description
Text	Tenant web service filter for the given record.

RetrieveTenantWebServiceFilter

Returns the tenant web service filter for a given record.

procedure RetrieveTenantWebServiceFilter(var TenantWebServiceFilter: Record "Tenant Web Service Filter"): Text

Parameters

Name	Type	Description
TenantWebServiceFilter	Record "Tenant Web Service Filter"	The record for getting filter.

Returns

Type	Description
Text	Tenant web service filter for the given record.

SetTenantWebServiceFilter

Sets the tenant web service filter for a given record.

procedure SetTenantWebServiceFilter(var TenantWebServiceFilter: Record "Tenant Web Service Filter", FilterText: Text)

Parameters

Name	Type	Description
TenantWebServiceFilter	Record "Tenant Web Service Filter"	The record for setting tenant web service filter.
FilterText	Text	The tenant web service filter that is set.

GetODataSelectClause

Returns the OData select clause for a given record.

procedure GetODataSelectClause(TenantWebServiceOData: Record "Tenant Web Service OData"): Text

Parameters

Name	Type	Description
TenantWebServiceOData	Record "Tenant Web Service OData"	The record for getting OData select clause.

Returns

Type	Description
Text	OData select clause for the given record.

SetODataSelectClause

Sets the OData select clause for a given record.

procedure SetODataSelectClause(var TenantWebServiceOData: Record "Tenant Web Service OData", ODataText: Text)

Parameters

Name	Type	Description
TenantWebServiceOData	Record "Tenant Web Service OData"	The record for setting OData select clause.
ODataText	Text	The OData select clause that is set.

GetODataFilterClause

Returns the OData filter clause for a given record.

procedure GetODataFilterClause(TenantWebServiceOData: Record "Tenant Web Service OData"): Text

Parameters

Name	Type	Description
TenantWebServiceOData	Record "Tenant Web Service OData"	The record for getting OData filter clause.

Returns

Type	Description
Text	OData filter clause for the given record.

SetODataFilterClause

Sets the OData filter clause for a given record.

procedure SetODataFilterClause(var TenantWebServiceOData: Record "Tenant Web Service OData", ODataText: Text)

Parameters

Name	Type	Description
TenantWebServiceOData	Record "Tenant Web Service OData"	The record for setting OData filter clause.
ODataText	Text	The OData filter clause that is set.

GetODataV4FilterClause

Returns the OData V4 filter clause for a given record.

procedure GetODataV4FilterClause(TenantWebServiceOData: Record "Tenant Web Service OData"): Text

Parameters

Name	Type	Description
TenantWebServiceOData	Record "Tenant Web Service OData"	The record for getting OData V4 filter clause.

Returns

Type	Description
Text	OData V4 filter clause for the given record.

SetODataV4FilterClause

Sets the OData V4 filter clause for a given record.

procedure SetODataV4FilterClause(var TenantWebServiceOData: Record "Tenant Web Service OData", ODataText: Text)

Parameters

Name	Type	Description
TenantWebServiceOData	Record "Tenant Web Service OData"	The record for setting OData V4 filter clause.
ODataText	Text	The OData V4 filter clause that is set.

GetObjectCaption

Gets the name of the object that will be exposed to the web service for a given record.

procedure GetObjectCaption(WebServiceAggregate: Record "Web Service Aggregate"): Text[80]

Parameters

Name	Type	Description
WebServiceAggregate	Record "Web Service Aggregate"	The record for getting the name of the object.

Returns

Type	Description
Text[80]	Name of the object.

LoadRecords

Loads records from Web Service and Tenant Web Service table into given Web Service Aggregate record.

procedure LoadRecords(var WebServiceAggregate: Record "Web Service Aggregate")

Parameters

Name	Type	Description
WebServiceAggregate	Record "Web Service Aggregate"	The variable that the records are loaded into.

LoadRecordsFromTenantWebServiceColumns

procedure LoadRecordsFromTenantWebServiceColumns(TenantWebService: __MissingTypeSymbol__)

Parameters

Name	Type	Description
TenantWebService	__MissingTypeSymbol__

InsertSelectedColumns

procedure InsertSelectedColumns(TenantWebService: __MissingTypeSymbol__, ColumnDictionary: DotNet "System.Collections.Generic.Dictionary`2", var TargetTenantWebServiceColumns: Record "Tenant Web Service Columns", DataItem: Integer)

Parameters

Name	Type	Description
TenantWebService	__MissingTypeSymbol__
ColumnDictionary	DotNet "System.Collections.Generic.Dictionary`2"
TargetTenantWebServiceColumns	Record "Tenant Web Service Columns"
DataItem	Integer

RemoveUnselectedColumnsFromFilter

procedure RemoveUnselectedColumnsFromFilter(TenantWebService: __MissingTypeSymbol__, DataItem: Integer, DataItemView: Text): Text

Parameters

Name	Type	Description
TenantWebService	__MissingTypeSymbol__
DataItem	Integer
DataItemView	Text

Returns

Type	Description
Text

IsServiceNameValid

Checks if given service name is valid.

procedure IsServiceNameValid(Value: Text): Boolean

Parameters

Name	Type	Description
Value	Text	The service name to be checked.

Returns

Type	Description
Boolean	If given service name valid or not.

DeleteWebService

Deletes a webservice.

procedure DeleteWebService(var WebServiceAggregate: Record "Web Service Aggregate")

Parameters

Name	Type	Description
WebServiceAggregate	Record "Web Service Aggregate"	The record to be deleted.

See also

• Codeunit