Jump to

• Request
• Response
• Examples

Create jobs

post

/fscmRestApi/resources/11.13.18.05/supplyChainPlans/{PlanId}/child/LoadMeasuresJobs

Request

Path Parameters

• PlanId(required): integer(int64)
  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:
  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/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CreatedBy: string
  User who created the load measures jobs.
• CreateNewCombFlag: boolean
  Contains one of the following values: true or false. If true, create combinations in the target plan and copy measure values from the source plan. If false, then don't create new combinations in the target. The default value is false.
• EndDate: string (date-time)
  Date and time when the scheduled process finished running.
• ESSJobId: integer (int64)
  Value that uniquely identifies the scheduled process.
• ExecutionId: integer (int64)
  Value that uniquely identifies the scheduled process.
• ExecutionUser: string
  Maximum Length: 64

  Login that the user used when starting the scheduled process.
• FromPlanName: string
  Name of source plan that the source measure data was copied from.
• LoadMeasuresStatus: integer (int32)
  Status of the load measures jobs. Valid values include 0: success, 1: in progress, 2: error or 3: Warning. This attribute doesn't have a default value.
• MeasureCopySetName: string
  Name of the measure copy set that contains at least one source measure to target measure relationship that will be referenced to copy data.
• Message: string
  Text of the error message that occurred when running the scheduled process.
• PlanAction: integer (int32)
  Plan action that calls the scheduled process. Value for load measures action is 16: load measures.
• PlanId: integer (int64)
  Value that uniquely identifies the target plan where the load measures process copied target measure to.
• SrcCatalogId: string
  Value that uniquely identifies the source measure catalog that has all the source plan measures.
• StartDate: string (date-time)
  Date and time when the scheduled process started to run.
• TargetCatalogId: string
  Value that uniquely identifies the target measure catalog that has all the target plan measures.
• TimeLevelRangeEnd: string
  Maximum Length: 255

  Value that identifies the ending bucket of a time range in the plan that receives measure data at the copy time level, expressed as a nonzero integer.
• TimeLevelRangeStart: string
  Maximum Length: 255

  Value that identifies the starting bucket of a time range in the plan that receives measure data at the copy time level, expressed as a nonzero integer.
• ToPlanId: string
  Value that uniquely identifies the target plan where the load measures process copied the target measure.

{
    "type":"object",
    "properties":{
        "SrcCatalogId":{
            "type":"string",
            "description":"Value that uniquely identifies the source measure catalog that has all the source plan measures.",
            "nullable":true
        },
        "FromPlanName":{
            "type":"string",
            "description":"Name of source plan that the source measure data was copied from.",
            "nullable":true
        },
        "CreatedBy":{
            "type":"string",
            "description":"User who created the load measures jobs.",
            "nullable":true
        },
        "Message":{
            "type":"string",
            "description":"Text of the error message that occurred when running the scheduled process.",
            "nullable":true
        },
        "MeasureCopySetName":{
            "type":"string",
            "description":"Name of the measure copy set that contains at least one source measure to target measure relationship that will be referenced to copy data.",
            "nullable":true
        },
        "ToPlanId":{
            "type":"string",
            "description":"Value that uniquely identifies the target plan where the load measures process copied the target measure.",
            "nullable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the target plan where the load measures process copied target measure to.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LoadMeasuresStatus":{
            "type":"integer",
            "description":"Status of the load measures jobs. Valid values include 0: success, 1: in progress, 2: error or 3: Warning. This attribute doesn't have a default value.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            }
        },
        "CreateNewCombFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, create combinations in the target plan and copy measure values from the source plan. If false, then don't create new combinations in the target. The default value is false.",
            "nullable":true
        },
        "ESSJobId":{
            "type":"integer",
            "description":"Value that uniquely identifies the scheduled process.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EndDate":{
            "type":"string",
            "description":"Date and time when the scheduled process finished running.",
            "format":"date-time",
            "nullable":true
        },
        "TimeLevelRangeStart":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the starting bucket of a time range in the plan that receives measure data at the copy time level, expressed as a nonzero integer.",
            "nullable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date and time when the scheduled process started to run.",
            "format":"date-time",
            "nullable":true
        },
        "TargetCatalogId":{
            "type":"string",
            "description":"Value that uniquely identifies the target measure catalog that has all the target plan measures.",
            "nullable":true
        },
        "ExecutionUser":{
            "maxLength":64,
            "type":"string",
            "description":"Login that the user used when starting the scheduled process.",
            "nullable":false
        },
        "PlanAction":{
            "type":"integer",
            "description":"Plan action that calls the scheduled process. Value for load measures action is 16: load measures.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":2
            }
        },
        "TimeLevelRangeEnd":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the ending bucket of a time range in the plan that receives measure data at the copy time level, expressed as a nonzero integer.",
            "nullable":true
        },
        "ExecutionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the scheduled process.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : supplyChainPlans-LoadMeasuresJobs-item-response

Type: object

Show Source

• CreatedBy: string
  User who created the load measures jobs.
• CreateNewCombFlag: boolean
  Contains one of the following values: true or false. If true, create combinations in the target plan and copy measure values from the source plan. If false, then don't create new combinations in the target. The default value is false.
• EndDate: string (date-time)
  Date and time when the scheduled process finished running.
• ESSJobId: integer (int64)
  Value that uniquely identifies the scheduled process.
• ExecutionId: integer (int64)
  Value that uniquely identifies the scheduled process.
• ExecutionUser: string
  Maximum Length: 64

  Login that the user used when starting the scheduled process.
• FromPlanName: string
  Name of source plan that the source measure data was copied from.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoadMeasuresStatus: integer (int32)
  Status of the load measures jobs. Valid values include 0: success, 1: in progress, 2: error or 3: Warning. This attribute doesn't have a default value.
• MeasureCopySetName: string
  Name of the measure copy set that contains at least one source measure to target measure relationship that will be referenced to copy data.
• Message: string
  Text of the error message that occurred when running the scheduled process.
• PlanAction: integer (int32)
  Plan action that calls the scheduled process. Value for load measures action is 16: load measures.
• PlanId: integer (int64)
  Value that uniquely identifies the target plan where the load measures process copied target measure to.
• SrcCatalogId: string
  Value that uniquely identifies the source measure catalog that has all the source plan measures.
• StartDate: string (date-time)
  Date and time when the scheduled process started to run.
• TargetCatalogId: string
  Value that uniquely identifies the target measure catalog that has all the target plan measures.
• TimeLevelRangeEnd: string
  Maximum Length: 255

  Value that identifies the ending bucket of a time range in the plan that receives measure data at the copy time level, expressed as a nonzero integer.
• TimeLevelRangeStart: string
  Maximum Length: 255

  Value that identifies the starting bucket of a time range in the plan that receives measure data at the copy time level, expressed as a nonzero integer.
• ToPlanId: string
  Value that uniquely identifies the target plan where the load measures process copied the target measure.

{
    "type":"object",
    "properties":{
        "SrcCatalogId":{
            "type":"string",
            "description":"Value that uniquely identifies the source measure catalog that has all the source plan measures.",
            "nullable":true,
            "x-queryable":true
        },
        "FromPlanName":{
            "type":"string",
            "description":"Name of source plan that the source measure data was copied from.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "type":"string",
            "description":"User who created the load measures jobs.",
            "nullable":true,
            "x-queryable":true
        },
        "Message":{
            "type":"string",
            "description":"Text of the error message that occurred when running the scheduled process.",
            "nullable":true,
            "x-queryable":true
        },
        "MeasureCopySetName":{
            "type":"string",
            "description":"Name of the measure copy set that contains at least one source measure to target measure relationship that will be referenced to copy data.",
            "nullable":true,
            "x-queryable":true
        },
        "ToPlanId":{
            "type":"string",
            "description":"Value that uniquely identifies the target plan where the load measures process copied the target measure.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the target plan where the load measures process copied target measure to.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LoadMeasuresStatus":{
            "type":"integer",
            "description":"Status of the load measures jobs. Valid values include 0: success, 1: in progress, 2: error or 3: Warning. This attribute doesn't have a default value.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "CreateNewCombFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, create combinations in the target plan and copy measure values from the source plan. If false, then don't create new combinations in the target. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "ESSJobId":{
            "type":"integer",
            "description":"Value that uniquely identifies the scheduled process.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date and time when the scheduled process finished running.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TimeLevelRangeStart":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the starting bucket of a time range in the plan that receives measure data at the copy time level, expressed as a nonzero integer.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date and time when the scheduled process started to run.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TargetCatalogId":{
            "type":"string",
            "description":"Value that uniquely identifies the target measure catalog that has all the target plan measures.",
            "nullable":true,
            "x-queryable":true
        },
        "ExecutionUser":{
            "maxLength":64,
            "type":"string",
            "description":"Login that the user used when starting the scheduled process.",
            "nullable":false,
            "x-queryable":true
        },
        "PlanAction":{
            "type":"integer",
            "description":"Plan action that calls the scheduled process. Value for load measures action is 16: load measures.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TimeLevelRangeEnd":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the ending bucket of a time range in the plan that receives measure data at the copy time level, expressed as a nonzero integer.",
            "nullable":true,
            "x-queryable":true
        },
        "ExecutionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the scheduled process.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

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

Examples

This example describes how to create load measure jobs.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.action+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/supplyChainPlans/PlanId/child/LoadMeasuresJobs"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
 "FromPlanName": "DM Plan",
 "MeasureCopySetName": "DM S&OP Integration",
 "CreateNewCombFlag": false,
 "TimeLevelRangeStart": -3,
 "TimeLevelRangeEnd": 18
}

Example Response Body

The following example includes the contents of the response body in JSON format:

"{
 "PlanId": 300100188638142,
 "ExecutionId": 300100188656467,
 "LoadMeasuresStatus": null,
 "ESSJobId": 71650,
 "StartDate": null,
 "EndDate": null,
 "ExecutionUser": null,
 "PlanAction": null,
 "ToPlanId": null,
 "SrcCatalogId": null,
 "TargetCatalogId": null,
 "CreateNewCombFlag": "false",
 "CreatedBy": null,
 "Message": "",
 "MeasureCopySetName": "DM S&OP Integration",
 "FromPlanName": "DM Plan",
 "TimeLevelRangeStart": "-3",
 "TimeLevelRangeEnd": "18",
 . . . 
}"

Back to Top