Jump to

• Request
• Response

Create runs

post

/fscmRestApi/resources/11.13.18.05/inventoryPlans/{PlanId}/child/Runs

Request

Path Parameters

• PlanId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActionParams: string
  List of entities to be refreshed. Each value is separated by a comma. Valid values are: 3 - Forecasts, 4 - Sales orders, and 6 - Supplies. There is no default value. This attribute is ignored unless Mode is set to 2.
• ArchivePlanFlag: boolean
  Contains one of the following values: true or false. If true, the plan is archived before the next plan run. If false, the plan isn't archived. The default value is false. Note that you can archive a plan only if it's enabled for archiving. Use the Enable for Archiving attribute in one of the work areas for supply chain planning to enable it.
• EndDate: string (date-time)
  Date and time when the plan run is completed.
• ExecutionId: integer (int64)
  Value that uniquely identifies the process.
• ExecutionUser: string
  Maximum Length: 64

  Login used by the user when launching the process.
• ForceRunFlag: boolean
  Contains one of the following values: true or false. If true, the plan is run regardless of the current plan status. If false, the plan is only run if it's ready to run. The default value is false.
• JobId: integer (int64)
  Value that uniquely identifies the scheduled process.
• Message: string
  Text of any error messages that occurred when running the scheduled process.
• Mode: string
  Specifies whether data is to be refreshed. Contains one of the following values: 1 - all data is refreshed, 2 - only selected entities are refreshed, or 3 - data isn't refreshed.
• PlanId: integer
  Value that uniquely identifies the inventory plan.
• RecalculateSafetyStockFlag: boolean
  Contains one of the following values: true or false. If true, then the safety stock is recalculated when running a plan. If false, then the safety stock isn't recalculated. This value is applicable only when the safety stock planning method plan option isn't 1: Don't plan safety stock or 4: User-specified values for all items.
• SavePlanToDb: string
  This attribute isn't currently used. Save the plan to database for future use such as plan simulation.
• StartDate: string (date-time)
  Date and time when the scheduled process is set to start.
• Status: integer (int32)
  Status of the plan run. Contains one of the following values: 0 - completed, 1 - processing, 2 - error, or 3 - warning. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_STATUS_TYPE.
• SubmissionNotes: string
  Notes provided by the user when submitting the plan from the Run Plan page.

{
    "type":"object",
    "properties":{
        "ActionParams":{
            "type":"string",
            "description":"List of entities to be refreshed. Each value is separated by a comma. Valid values are: 3 - Forecasts, 4 - Sales orders, and 6 - Supplies. There is no default value. This attribute is ignored unless Mode is set to 2.",
            "nullable":true
        },
        "ArchivePlanFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the plan is archived before the next plan run. If false, the plan isn't archived. The default value is false. Note that you can archive a plan only if it's enabled for archiving. Use the Enable for Archiving attribute in one of the work areas for supply chain planning to enable it.",
            "nullable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date and time when the plan run is completed.",
            "format":"date-time",
            "nullable":true
        },
        "ExecutionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the process.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ExecutionUser":{
            "maxLength":64,
            "type":"string",
            "description":"Login used by the user when launching the process.",
            "nullable":false
        },
        "ForceRunFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the plan is run regardless of the current plan status. If false, the plan is only run if it's ready to run. The default value is false.",
            "nullable":true
        },
        "JobId":{
            "type":"integer",
            "description":"Value that uniquely identifies the scheduled process.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Message":{
            "type":"string",
            "description":"Text of any error messages that occurred when running the scheduled process.",
            "nullable":true
        },
        "Mode":{
            "type":"string",
            "description":"Specifies whether data is to be refreshed. Contains one of the following values: 1 - all data is refreshed, 2 - only selected entities are refreshed, or 3 - data isn't refreshed.",
            "nullable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory plan.",
            "nullable":false
        },
        "RecalculateSafetyStockFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the safety stock is recalculated when running a plan. If false, then the safety stock isn't recalculated. This value is applicable only when the safety stock planning method plan option isn't 1: Don't plan safety stock or 4: User-specified values for all items.",
            "nullable":true
        },
        "SavePlanToDb":{
            "type":"string",
            "description":"This attribute isn't currently used. Save the plan to database for future use such as plan simulation.",
            "nullable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date and time when the scheduled process is set to start.",
            "format":"date-time",
            "nullable":true
        },
        "Status":{
            "type":"integer",
            "description":"Status of the plan run. Contains one of the following values: 0 - completed, 1 - processing, 2 - error, or 3 - warning. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_STATUS_TYPE.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            }
        },
        "SubmissionNotes":{
            "type":"string",
            "description":"Notes provided by the user when submitting the plan from the Run Plan page.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : inventoryPlans-Runs-item-response

Type: object

Show Source

• ActionParams: string
  List of entities to be refreshed. Each value is separated by a comma. Valid values are: 3 - Forecasts, 4 - Sales orders, and 6 - Supplies. There is no default value. This attribute is ignored unless Mode is set to 2.
• ArchivePlanFlag: boolean
  Contains one of the following values: true or false. If true, the plan is archived before the next plan run. If false, the plan isn't archived. The default value is false. Note that you can archive a plan only if it's enabled for archiving. Use the Enable for Archiving attribute in one of the work areas for supply chain planning to enable it.
• EndDate: string (date-time)
  Date and time when the plan run is completed.
• ExecutionId: integer (int64)
  Value that uniquely identifies the process.
• ExecutionUser: string
  Maximum Length: 64

  Login used by the user when launching the process.
• ForceRunFlag: boolean
  Contains one of the following values: true or false. If true, the plan is run regardless of the current plan status. If false, the plan is only run if it's ready to run. The default value is false.
• JobId: integer (int64)
  Value that uniquely identifies the scheduled process.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Message: string
  Text of any error messages that occurred when running the scheduled process.
• Mode: string
  Specifies whether data is to be refreshed. Contains one of the following values: 1 - all data is refreshed, 2 - only selected entities are refreshed, or 3 - data isn't refreshed.
• PlanId: integer
  Value that uniquely identifies the inventory plan.
• RecalculateSafetyStockFlag: boolean
  Contains one of the following values: true or false. If true, then the safety stock is recalculated when running a plan. If false, then the safety stock isn't recalculated. This value is applicable only when the safety stock planning method plan option isn't 1: Don't plan safety stock or 4: User-specified values for all items.
• SavePlanToDb: string
  This attribute isn't currently used. Save the plan to database for future use such as plan simulation.
• StartDate: string (date-time)
  Date and time when the scheduled process is set to start.
• Status: integer (int32)
  Status of the plan run. Contains one of the following values: 0 - completed, 1 - processing, 2 - error, or 3 - warning. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_STATUS_TYPE.
• SubmissionNotes: string
  Notes provided by the user when submitting the plan from the Run Plan page.

{
    "type":"object",
    "properties":{
        "ActionParams":{
            "type":"string",
            "description":"List of entities to be refreshed. Each value is separated by a comma. Valid values are: 3 - Forecasts, 4 - Sales orders, and 6 - Supplies. There is no default value. This attribute is ignored unless Mode is set to 2.",
            "nullable":true,
            "x-queryable":true
        },
        "ArchivePlanFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the plan is archived before the next plan run. If false, the plan isn't archived. The default value is false. Note that you can archive a plan only if it's enabled for archiving. Use the Enable for Archiving attribute in one of the work areas for supply chain planning to enable it.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date and time when the plan run is completed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ExecutionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the process.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExecutionUser":{
            "maxLength":64,
            "type":"string",
            "description":"Login used by the user when launching the process.",
            "nullable":false,
            "x-queryable":true
        },
        "ForceRunFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the plan is run regardless of the current plan status. If false, the plan is only run if it's ready to run. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "JobId":{
            "type":"integer",
            "description":"Value that uniquely identifies the scheduled process.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Message":{
            "type":"string",
            "description":"Text of any error messages that occurred when running the scheduled process.",
            "nullable":true,
            "x-queryable":true
        },
        "Mode":{
            "type":"string",
            "description":"Specifies whether data is to be refreshed. Contains one of the following values: 1 - all data is refreshed, 2 - only selected entities are refreshed, or 3 - data isn't refreshed.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory plan.",
            "nullable":false,
            "x-queryable":true
        },
        "RecalculateSafetyStockFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the safety stock is recalculated when running a plan. If false, then the safety stock isn't recalculated. This value is applicable only when the safety stock planning method plan option isn't 1: Don't plan safety stock or 4: User-specified values for all items.",
            "nullable":true,
            "x-queryable":true
        },
        "SavePlanToDb":{
            "type":"string",
            "description":"This attribute isn't currently used. Save the plan to database for future use such as plan simulation.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date and time when the scheduled process is set to start.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "type":"integer",
            "description":"Status of the plan run. Contains one of the following values: 0 - completed, 1 - processing, 2 - error, or 3 - warning. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_STATUS_TYPE.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "SubmissionNotes":{
            "type":"string",
            "description":"Notes provided by the user when submitting the plan from the Run Plan page.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top