Jump to

• Request
• Response

Generate forecasts for assets in a work requirement

post

/fscmRestApi/resources/11.13.18.05/maintenanceForecasts/action/generateWorkRequirementForecasts

Generates forecasts for assets in a work requirement. This service can be accessed through the Maintenance Work Requirement Redwood page to create forecasts for the assets listed in the work requirement.

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

• assetId: number
  Value that uniquely identifies an affected asset within a work requirement.
• ingestIndex: string
  Contains one of the following values: true or false. If true, forecast data is ingested into the index. The default value is false.
• requirementId: number
  Value that uniquely identifies a work requirement across all maintenance programs

{
    "type":"object",
    "properties":{
        "assetId":{
            "type":"number",
            "description":"Value that uniquely identifies an affected asset within a work requirement.",
            "nullable":true
        },
        "requirementId":{
            "type":"number",
            "description":"Value that uniquely identifies a work requirement across all maintenance programs",
            "nullable":true
        },
        "ingestIndex":{
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, forecast data is ingested into the index. The default value is false.",
            "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): string
  If the action is completed successfully, then it returns the process ID for generating the forecasts.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"If the action is completed successfully, then it returns the process ID for generating the forecasts."
        }
    },
    "additionalProperties":false
}

Back to Top