Home > References

Built-in services description

EBX.Platform includes several built-in services. This reference page offers a description of these services including their parameters.

Access to a content (default service)

The default service. The default service is automatically considered complete.

Manager Component API: default service used if no service is specified.

input parameters

Parameter Description
branch Branch: The identifier of the specified branch - The branch or the version is required for this service.
instance Adaptation instance: The value must be the reference of an adaptation that exists in the home (branch or version) selected.
trackingInfo Tracking informations: Tracking info is logged into EBX.Platform 'history' logs. It may also be used for any other purpose like access control or additional export information.
version Version: The identifier of the specified branch - The branch or the version is required for this service.
xpath Instance node (XPath): The value must be a valid absolute location path in the adaptation instance selected. The notation must conform to a simplified XPath, in its abbreviated syntax.

Compare contents

The compare service is automatically considered complete.

Manager Component API: service=@compare

input parameters

Parameter Description
branch Branch: The identifier of the specified branch - The branch and the branch to compare (or the version and the version to compare) are required for this service.
compare.branch Branch to compare: The identifier of the branch to compare - The branch and the branch to compare (or the version and the version to compare) are required for this service.
compare.instance Adaptation instance to compare: The value must be the reference of an adaptation that exists in the selected home to compare (branch or version).
compare.version Version to compare: The identifier oh the version to compare - The branch and the branch to compare (or the version and the version to compare) are required for this service.
compare.xpath Table or record to compare (XPath) : The value must be a valid absolute location path of a table or a record in the selected adaptation instance to compare. The notation must conform to a simplified XPath, in its abbreviated syntax.
instance Adaptation instance: The value must be the reference of an adaptation that exists in the home (branch or version) selected.
trackingInfo Tracking informations: Tracking info is logged into EBX.Platform 'history' logs. It may also be used for any other purpose like access control or additional export information.
version Version: The identifier of the specified version - The branch and the branch to compare (or the version and the version to compare) are required for this service.
xpath Table or record (XPath): The value must be a valid absolute location path of a table or a record in the selected adaptation instance. The notation must conform to a simplified XPath, in its abbreviated syntax.

Create a new record

The creation service is considered complete when the first successful submit is performed (record has been created). If this service is called whereas it is already complete, the created record is displayed in update or read-only mode (depending on the user rights).

Manager Component API: service=@creation

input parameters

Parameter Description
branch Branch: The identifier of the specified branch - This field is required for this service.
instance Adaptation instance: The value must be the reference of an adaptation that exists in the selected branch - This field is required for this service.
trackingInfo Tracking informations: Tracking info is logged into EBX.Platform 'history' logs. It may also be used for any other purpose like access control or additional export information.
xpath Instance table (XPath): The value must be a valid absolute location path of a table in the adaptation instance selected. The notation must conform to a simplified XPath, in its abbreviated syntax - This field is required for this service.

output parameters

Parameter Description
created Created record: Contains the XPath of the created record.

Duplicate a record

The duplicate service is considered complete when the first successful submit is performed (record has been created). If this service is called whereas it is already complete, the created record is displayed in update or read-only mode (depending on the user rights).

Manager Component API: service=@duplicate

input parameters

Parameter Description
branch Branch: The identifier of the specified branch -This field is required for this service.
instance Adaptation instance: The value must be the reference of an adaptation that exists in the selected branch - This field is required for this service.
trackingInfo Tracking informations: Tracking info is logged into EBX.Platform 'history' logs. It may also be used for any other purpose like access control or additional export information.
xpath Instance record to duplicate (XPath) : The value must be a valid absolute location path of an existing record. The notation must conform to a simplified XPath, in its abbreviated syntax - This field is required for this service.

output parameters

Parameter Description
created Created record: Contains the XPath of the created record.

Export data from a table in CSV Files

The exportToCSV service is considered complete when export is done and file downloaded.

Manager Component API: service=@exportToCSV

input parameters

Parameter Description
branch Branch: The identifier of the specified branch - The branch or the version is required for this service.
instance Adaptation instance: The value must be the reference of an adaptation that exists in the home (branch or version) selected - This field is required for this service.
trackingInfo Tracking informations: Tracking info is logged into EBX.Platform 'history' logs. It may also be used for any other purpose like access control or additional export information.
version Version: The identifier of the specified version - The branch or the version is required for this service.
xpath Instance table to export (XPath): The value must be a valid absolute location path of a table in the adaptation instance selected. The notation must conform to a simplified XPath, in its abbreviated syntax -This field is required for this service.

Export data from a table in XML files

The exportToXML service is considered complete when export is done and file downloaded.

Manager Component API: service=@exportToXML

input parameters

Parameter Description
branch Branch: The identifier of the specified branch - The branch or the version is required for this service.
instance Adaptation instance: The value must be the reference of an adaptation that exists in the home (branch or version) selected - This field is required for this service.
trackingInfo Tracking informations: Tracking info is logged into EBX.Platform 'history' logs. It may also be used for any other purpose like access control or additional export information.
version Version: The identifier of the specified version - The branch or the version is required for this service.
xpath Instance table to export (XPath): The value must be a valid absolute location path of a table in the adaptation instance selected. The notation must conform to a simplified XPath, in its abbreviated syntax - This field is required for this service.

Import data into a table from a CSV file

The importFromCSV service is considered complete when import is performed.

Manager Component API: service=@importFromCSV

input parameters

Parameter Description
branch Branch: The identifier of the specified branch - This field is required for this service.
instance Adaptation instance: The value must be the reference of an adaptation that exists in the selected branch - This field is required for this service.
trackingInfo Tracking informations: Tracking info is logged into EBX.Platform 'history' logs. It may also be used for any other purpose like access control or additional export information.
xpath Instance table in which import (XPath) : The value must be a valid absolute location path of a table in the adaptation instance selected. The notation must conform to a simplified XPath, in its abbreviated syntax - This field is required for this service.

Import data into a table from an XML file

The importFromXML service is considered complete when import is performed.

Manager Component API: service=@importFromXML

input parameters

Parameter Description
branch Branch: The identifier of the specified branch - This field is required for this service.
instance Adaptation instance: The value must be the reference of an adaptation that exists in the selected branch - This field is required for this service.
trackingInfo Tracking informations: Tracking info is logged into EBX.Platform 'history' logs. It may also be used for any other purpose like access control or additional export information.
xpath Instance table in which import (XPath) : The value must be a valid absolute location path of a table in the adaptation instance selected. The notation must conform to a simplified XPath, in its abbreviated syntax. This field is required for this service.

Merge a branch

The merge service is considered complete when merger is performed and branch is closed.

Manager Component API: service=@merge

input parameters

Parameter Description
branch Branch: The identifier oh the specified branch - This field is required for this service.
trackingInfo Tracking informations: Tracking info is logged into EBX.Platform 'history' logs. It may also be used for any other purpose like access control or additional export information.

output parameters

Parameter Description
mergeResult Merge success: Contains 'true' if merge succeeded, otherwise 'false'.
mergeState Merge state: Contains the return code of the merge. It is strongly recommended to parse this value by using the InteractionMergeState UIHttpManagerComponentReturnCode.

Validate a branch, a version or an adaptation instance

The validation service is automatically considered complete.

Manager Component API: service=@validation

input parameters

Parameter Description
branch Branch: The identifier of the specified branch - The branch or the version is required for this service.
instance Adaptation instance: the value must be the reference of an adaptation that exists in the home (branch or version) selected.
trackingInfo Tracking informations: Tracking info is logged into EBX.Platform 'history' logs. It may also be used for any other purpose like access control or additional export information.
version Version: The identifier oh the specified version - The branch or the version is required for this service.

output parameters

Parameter Description
hasError Found errors: Contains 'true' if validation has produced errors.
hasFatal Found fatal errors: Contains 'true' if validation has produced fatal errors.
hasInfo Found informations: Contains 'true' if validation has produced informations.
hasWarning Found warnings: Contains 'true' if validation has produced warnings.

Home > References