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 elastic Search Ui,where user performs a search and then chooses to export the asset details. This method will collect all the assets searched and based on the inputs passed it will schedule the ESS job for Asset export and Meter export. The inputs passed withh 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:
  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:
  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
• exportAssetCharge: boolean
• exportChildAsset: boolean
• exportChildAssetMeter: boolean
• exportPartlist: boolean
• meterExport: boolean
• payload: string

{
    "type":"object",
    "properties":{
        "exportChildAsset":{
            "type":"boolean",
            "nullable":true
        },
        "payload":{
            "type":"string",
            "nullable":true
        },
        "exportAssetCharge":{
            "type":"boolean",
            "nullable":true
        },
        "exportChildAssetMeter":{
            "type":"boolean",
            "nullable":true
        },
        "exportPartlist":{
            "type":"boolean",
            "nullable":true
        },
        "meterExport":{
            "type":"boolean",
            "nullable":true
        },
        "assetExport":{
            "type":"boolean",
            "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