Jump to

• Request
• Response
• Examples

Create delete plan job

post

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

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

• DeleteStatus: integer (int32)
  Status of the scheduled process that deletes the plan. Valid values include 0: success, 1: in progress, or 2: error. This attribute doesn't have a default value.
• 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 launching the process.
• ForceDeleteFlag: boolean
  Contains one of the following values: true or false. If true, then delete the plan regardless of whether there are other plans that reference the plan being deleted. If false, then delete the plan only if there aren't any other plans that reference the plan being deleted.
• Message: string
  Text of the error message, if any, that occurred when running the scheduled process.
• PlanAction: integer (int32)
  Plan action that calls the scheduled process. Value for the delete action is 10.
• PlanId: integer
  Value that uniquely identifies the plan.
• StartDate: string (date-time)
  Date and time when the scheduled process started.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "type":"string",
            "description":"Date and time when the scheduled process started.",
            "format":"date-time",
            "nullable":true
        },
        "Message":{
            "type":"string",
            "description":"Text of the error message, if any, that occurred when running the scheduled process.",
            "nullable":true
        },
        "ExecutionUser":{
            "maxLength":64,
            "type":"string",
            "description":"Login that the user used when launching the process.",
            "nullable":false
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "nullable":false
        },
        "PlanAction":{
            "type":"integer",
            "description":"Plan action that calls the scheduled process. Value for the delete action is 10.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":2
            }
        },
        "ForceDeleteFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then delete the plan regardless of whether there are other plans that reference the plan being deleted. If false, then delete the plan only if there aren't any other plans that reference the plan being deleted.",
            "nullable":true
        },
        "DeleteStatus":{
            "type":"integer",
            "description":"Status of the scheduled process that deletes the plan. Valid values include 0: success, 1: in progress, or 2: error. This attribute doesn't have a default value.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            }
        },
        "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
        },
        "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-Deletes-item-response

Type: object

Show Source

• DeleteStatus: integer (int32)
  Status of the scheduled process that deletes the plan. Valid values include 0: success, 1: in progress, or 2: error. This attribute doesn't have a default value.
• 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 launching the process.
• ForceDeleteFlag: boolean
  Contains one of the following values: true or false. If true, then delete the plan regardless of whether there are other plans that reference the plan being deleted. If false, then delete the plan only if there aren't any other plans that reference the plan being deleted.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Message: string
  Text of the error message, if any, that occurred when running the scheduled process.
• PlanAction: integer (int32)
  Plan action that calls the scheduled process. Value for the delete action is 10.
• PlanId: integer
  Value that uniquely identifies the plan.
• StartDate: string (date-time)
  Date and time when the scheduled process started.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "type":"string",
            "description":"Date and time when the scheduled process started.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Message":{
            "type":"string",
            "description":"Text of the error message, if any, that occurred when running the scheduled process.",
            "nullable":true,
            "x-queryable":true
        },
        "ExecutionUser":{
            "maxLength":64,
            "type":"string",
            "description":"Login that the user used when launching the process.",
            "nullable":false,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "nullable":false,
            "x-queryable":true
        },
        "PlanAction":{
            "type":"integer",
            "description":"Plan action that calls the scheduled process. Value for the delete action is 10.",
            "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"
            }
        },
        "ForceDeleteFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then delete the plan regardless of whether there are other plans that reference the plan being deleted. If false, then delete the plan only if there aren't any other plans that reference the plan being deleted.",
            "nullable":true,
            "x-queryable":true
        },
        "DeleteStatus":{
            "type":"integer",
            "description":"Status of the scheduled process that deletes the plan. Valid values include 0: success, 1: in progress, or 2: error. This attribute doesn't have a default value.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            },
            "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
        },
        "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

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/supplyChainPlans/PlanId/child/Deletes"

For example, this example describes how to create a delete plan job.

curl -u username:password "https://servername/fscmRestApi/resources/version/supplyChainPlans/300100543809995/child/Deletes"

Example Request Body

The following example includes the contents of the request body in JSON format.

{}

Example Response Body

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

{
    "PlanId": 300100543809995,
    "ExecutionId": 300100543820305,
    "DeleteStatus": null,
    "ESSJobId": 83180,
    "StartDate": null,
    "EndDate": null,
    "ExecutionUser": "SCMOPERATIONS",
    "PlanAction": 10,
    "Message": "",
    "ForceDeleteFlag": "false",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/supplyChainPlans/300100543809995/child/Deletes/300100543820305",
            "name": "Deletes",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/supplyChainPlans/300100543809995/child/Deletes/300100543820305",
            "name": "Deletes",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/supplyChainPlans/300100543809995",
            "name": "supplyChainPlans",
            "kind": "item"
        }
    ]
}

Back to Top