Jump to

• Request
• Response

Method used to perform an export operation for assets and meters.

post

/fscmRestApi/resources/11.13.18.05/installedBaseAssets/action/exportAssets

This is primarily to support the export feature from the elastic Search UI, where the user performs a search and then chooses to export the asset details. This method collects all the assets searched and, based on the inputs passed, it will schedule the Asset export and Meter export scheduled process. The inputs passed will drive the logic to either schedule the asset export or meter export or both the jobs with their respective children components.

Request

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• assetExport: boolean
  Value that identifies if the asset export job is to be scheduled.
• exportAssetCharge: boolean
  Value that identifies if the asset charge component needs to be exported for the selected assets.
• exportChildAsset: boolean
  Value that identities if child assets are to be exported for the selected assets.
• exportChildAssetMeter: boolean
  Value that identifies if the child asset meters are to be exported with the asset meters.
• exportPartlist: boolean
  Value that identifies if the parts list component of the selected asset needs to be exported.
• meterExport: boolean
  Value that identifies if the meter export job is to scheduled.
• payload: string
  Identifies the filters to be used by the elastic search REST API to get the result asset set to be used for export.

{
    "type":"object",
    "properties":{
        "exportChildAsset":{
            "type":"boolean",
            "description":"Value that identities if child assets are to be exported for the selected assets.",
            "nullable":true
        },
        "payload":{
            "type":"string",
            "description":"Identifies the filters to be used by the elastic search REST API to get the result asset set to be used for export.",
            "nullable":true
        },
        "exportAssetCharge":{
            "type":"boolean",
            "description":"Value that identifies if the asset charge component needs to be exported for the selected assets.",
            "nullable":true
        },
        "exportChildAssetMeter":{
            "type":"boolean",
            "description":"Value that identifies if the child asset meters are to be exported with the asset meters.",
            "nullable":true
        },
        "exportPartlist":{
            "type":"boolean",
            "description":"Value that identifies if the parts list component of the selected asset needs to be exported.",
            "nullable":true
        },
        "meterExport":{
            "type":"boolean",
            "description":"Value that identifies if the meter export job is to scheduled.",
            "nullable":true
        },
        "assetExport":{
            "type":"boolean",
            "description":"Value that identifies if the asset export job is to be scheduled.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): number
  If the action completes successfully, then exportAsset returns the scheduled job ID for Asset Export and Asset Meter.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"number",
            "description":"If the action completes successfully, then exportAsset returns the scheduled job ID for Asset Export and Asset Meter."
        }
    },
    "additionalProperties":false
}

Back to Top