Jump to

• Request
• Response

Method used to generate a forecast for maintenance programs.

post

/fscmRestApi/resources/11.13.18.05/maintenancePrograms/action/generateProgramForecasts

Method used to generate forecast for maintenancePrograms

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

• organizationId: number
  Value that uniquely identifies the organization the program is being forecasted for.
• programIdList: array programIdList
  List of values that uniquely identifies the maintenance program to be forecasted.

{
    "type":"object",
    "properties":{
        "organizationId":{
            "type":"number",
            "description":"Value that uniquely identifies the organization the program is being forecasted for.",
            "nullable":true
        },
        "programIdList":{
            "type":"array",
            "description":"List of values that uniquely identifies the maintenance program to be forecasted.",
            "nullable":true,
            "items":{
                "type":"number"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : programIdList

Type: array

List of values that uniquely identifies the maintenance program to be forecasted.

Show Source

• Array of: number

{
    "type":"array",
    "description":"List of values that uniquely identifies the maintenance program to be forecasted.",
    "nullable":true,
    "items":{
        "type":"number"
    }
}

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 the process ID for the generate forecast job is returned.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"If the action is completed successfully, then the process ID for the generate forecast job is returned."
        }
    },
    "additionalProperties":false
}

Back to Top