Jump to

• Request
• Response

Create one policy profile

post

/fscmRestApi/resources/11.13.18.05/minMaxPolicyProfiles

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DefCarryingCost: integer
  Default value defined for the carrying cost percentage.
• DefDailyDemand: integer (int64)
  Default value defined for the average daily demand.
• DefOrderingCost: integer
  Default value defined for the ordering cost.
• DefStandardCost: integer
  Default value defined for the standard cost.
• DeliveriesPerTimePeriod: number
  Number of deliveries to be done in a time period.
• EoqOverride: integer (int64)
  Manual override value defined for the economic order quantity.
• ExPercentage: integer (int32)
  Percentage value defined to multiply with the calculated average daily demand to get new average daily demand value.
• HistoryDataDays: integer (int64)
  Number of days used to consider history when calculating average daily demand.
• MaxCalcMethod: integer (int32)
  Code of the maximum quantity calculation method.
• MaxCalcMethodName: string
  Maximum Length: 255

  Method used to calculate the maximum quantity. Valid values are Days of Cover, Minimum plus order quantity, and Minimum plus EOQ. The default value is Days of Cover.
• MaxOverride: integer (int64)
  Manual override value of the maximum quantity.
• MaxQty: integer
  Value of the maximum quantity.
• MinOverride: integer (int64)
  Manual override value of the minimum quantity.
• ObjectVersionNumber: integer (int32)
  Number of times the object has been updated.
• OrdQty: integer
  Value of order quantity.
• ParTimePeriod: number
  Value of the PAR time period.
• PolicyCode: string
  Maximum Length: 120

  Code of the policy profile.
• PolicyDescription: string
  Maximum Length: 240

  Name of the policy profile.
• PolicyId: integer (int64)
  Unique identifier of the policy profile.
• PolicyProfileName: string
  Maximum Length: 120

  Name of the policy profile.
• PolicySpec: integer (int32)
  Code of the policy unit of measure.
• PolicyType: integer (int32)
  Code of the policy type.
• PolicyTypeName: string
  Maximum Length: 255

  Type of policy.
• SsCalcMethod: integer (int32)
  Code of the safety stock calculation method.
• SsDaysOfCoverage: integer (int64)
  Value that indicates the safety stock days of cover.
• SsOverride: integer (int64)
  Manual override value defined for the safety stock.

{
    "type":"object",
    "properties":{
        "DefCarryingCost":{
            "type":"integer",
            "description":"Default value defined for the carrying cost percentage.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "EoqOverride",
                    "MaxCalcMethod",
                    "MaxOverride"
                ]
            }
        },
        "DefDailyDemand":{
            "type":"integer",
            "description":"Default value defined for the average daily demand.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DefOrderingCost":{
            "type":"integer",
            "description":"Default value defined for the ordering cost.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "EoqOverride",
                    "MaxCalcMethod",
                    "MaxOverride"
                ]
            }
        },
        "DefStandardCost":{
            "type":"integer",
            "description":"Default value defined for the standard cost.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "EoqOverride",
                    "MaxCalcMethod",
                    "MaxOverride"
                ]
            }
        },
        "DeliveriesPerTimePeriod":{
            "type":"number",
            "description":"Number of deliveries to be done in a time period.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PolicyType"
                ]
            }
        },
        "EoqOverride":{
            "type":"integer",
            "description":"Manual override value defined for the economic order quantity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "MaxCalcMethod"
                ]
            }
        },
        "ExPercentage":{
            "type":"integer",
            "description":"Percentage value defined to multiply with the calculated average daily demand to get new average daily demand value.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":4
            }
        },
        "HistoryDataDays":{
            "type":"integer",
            "description":"Number of days used to consider history when calculating average daily demand.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "MaxCalcMethod":{
            "type":"integer",
            "description":"Code of the maximum quantity calculation method.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8,
                "dependencies":[
                    "PolicyType"
                ]
            }
        },
        "MaxCalcMethodName":{
            "maxLength":255,
            "type":"string",
            "description":"Method used to calculate the maximum quantity. Valid values are Days of Cover, Minimum plus order quantity, and Minimum plus EOQ. The default value is Days of Cover.",
            "nullable":true
        },
        "MaxOverride":{
            "type":"integer",
            "description":"Manual override value of the maximum quantity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "MaxCalcMethod"
                ]
            }
        },
        "MaxQty":{
            "type":"integer",
            "description":"Value of the maximum quantity.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "MaxCalcMethod",
                    "MaxOverride"
                ]
            }
        },
        "MinOverride":{
            "type":"integer",
            "description":"Manual override value of the minimum quantity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the object has been updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "OrdQty":{
            "type":"integer",
            "description":"Value of order quantity.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "MaxCalcMethod",
                    "MaxOverride"
                ]
            }
        },
        "ParTimePeriod":{
            "type":"number",
            "description":"Value of the PAR time period.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PolicyType"
                ]
            }
        },
        "PolicyCode":{
            "maxLength":120,
            "type":"string",
            "description":"Code of the policy profile.",
            "nullable":true
        },
        "PolicyDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the policy profile.",
            "nullable":true
        },
        "PolicyId":{
            "type":"integer",
            "description":"Unique identifier of the policy profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PolicyProfileName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the policy profile.",
            "nullable":false
        },
        "PolicySpec":{
            "type":"integer",
            "description":"Code of the policy unit of measure.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            }
        },
        "PolicyType":{
            "type":"integer",
            "description":"Code of the policy type.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            }
        },
        "PolicyTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Type of policy.",
            "nullable":true
        },
        "SsCalcMethod":{
            "type":"integer",
            "description":"Code of the safety stock calculation method.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            }
        },
        "SsDaysOfCoverage":{
            "type":"integer",
            "description":"Value that indicates the safety stock days of cover.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "MinOverride",
                    "SsOverride"
                ]
            }
        },
        "SsOverride":{
            "type":"integer",
            "description":"Manual override value defined for the safety stock.",
            "format":"int64",
            "nullable":true,
            "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:
  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 : minMaxPolicyProfiles-item-response

Type: object

Show Source

• AssociationAvailableFlag: boolean
  Read Only: true

  Maximum Length: 255

  Value that indicates if the policy profile is used in any of the existing policy assignments.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the policy profile.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the policy profile.
• DefCarryingCost: integer
  Default value defined for the carrying cost percentage.
• DefDailyDemand: integer (int64)
  Default value defined for the average daily demand.
• DefOrderingCost: integer
  Default value defined for the ordering cost.
• DefStandardCost: integer
  Default value defined for the standard cost.
• DeliveriesPerTimePeriod: number
  Number of deliveries to be done in a time period.
• EoqOverride: integer (int64)
  Manual override value defined for the economic order quantity.
• ExPercentage: integer (int32)
  Percentage value defined to multiply with the calculated average daily demand to get new average daily demand value.
• HistoryDataDays: integer (int64)
  Number of days used to consider history when calculating average daily demand.
• LastUpdateDate: string (date-time)
  Read Only: true

  Last update date of the policy profile.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the policy profile.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login used to update the policy profile.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaxCalcMethod: integer (int32)
  Code of the maximum quantity calculation method.
• MaxCalcMethodName: string
  Maximum Length: 255

  Method used to calculate the maximum quantity. Valid values are Days of Cover, Minimum plus order quantity, and Minimum plus EOQ. The default value is Days of Cover.
• MaxOverride: integer (int64)
  Manual override value of the maximum quantity.
• MaxQty: integer
  Value of the maximum quantity.
• MinOverride: integer (int64)
  Manual override value of the minimum quantity.
• ObjectVersionNumber: integer (int32)
  Number of times the object has been updated.
• OrdQty: integer
  Value of order quantity.
• ParTimePeriod: number
  Value of the PAR time period.
• PolicyCode: string
  Maximum Length: 120

  Code of the policy profile.
• PolicyDescription: string
  Maximum Length: 240

  Name of the policy profile.
• PolicyId: integer (int64)
  Unique identifier of the policy profile.
• PolicyProfileName: string
  Maximum Length: 120

  Name of the policy profile.
• PolicySpec: integer (int32)
  Code of the policy unit of measure.
• PolicyType: integer (int32)
  Code of the policy type.
• PolicyTypeName: string
  Maximum Length: 255

  Type of policy.
• PolicyUnitsSpecName: string
  Read Only: true

  Maximum Length: 255

  Policy unit of measure type.
• SsCalcMethod: integer (int32)
  Code of the safety stock calculation method.
• SSCalcMethodName: string
  Read Only: true

  Maximum Length: 255

  Method used to calculate the safety stock.
• SsDaysOfCoverage: integer (int64)
  Value that indicates the safety stock days of cover.
• SsOverride: integer (int64)
  Manual override value defined for the safety stock.

{
    "type":"object",
    "properties":{
        "AssociationAvailableFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Value that indicates if the policy profile is used in any of the existing policy assignments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the policy profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the policy profile.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefCarryingCost":{
            "type":"integer",
            "description":"Default value defined for the carrying cost percentage.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "EoqOverride",
                    "MaxCalcMethod",
                    "MaxOverride"
                ]
            },
            "x-queryable":true
        },
        "DefDailyDemand":{
            "type":"integer",
            "description":"Default value defined for the average daily demand.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DefOrderingCost":{
            "type":"integer",
            "description":"Default value defined for the ordering cost.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "EoqOverride",
                    "MaxCalcMethod",
                    "MaxOverride"
                ]
            },
            "x-queryable":true
        },
        "DefStandardCost":{
            "type":"integer",
            "description":"Default value defined for the standard cost.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "EoqOverride",
                    "MaxCalcMethod",
                    "MaxOverride"
                ]
            },
            "x-queryable":true
        },
        "DeliveriesPerTimePeriod":{
            "type":"number",
            "description":"Number of deliveries to be done in a time period.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PolicyType"
                ]
            },
            "x-queryable":true
        },
        "EoqOverride":{
            "type":"integer",
            "description":"Manual override value defined for the economic order quantity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "MaxCalcMethod"
                ]
            },
            "x-queryable":true
        },
        "ExPercentage":{
            "type":"integer",
            "description":"Percentage value defined to multiply with the calculated average daily demand to get new average daily demand value.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":4
            },
            "x-queryable":true
        },
        "HistoryDataDays":{
            "type":"integer",
            "description":"Number of days used to consider history when calculating average daily demand.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Last update date of the policy profile.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login used to update the policy profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the policy profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaxCalcMethod":{
            "type":"integer",
            "description":"Code of the maximum quantity calculation method.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8,
                "dependencies":[
                    "PolicyType"
                ]
            },
            "x-queryable":true
        },
        "MaxCalcMethodName":{
            "maxLength":255,
            "type":"string",
            "description":"Method used to calculate the maximum quantity. Valid values are Days of Cover, Minimum plus order quantity, and Minimum plus EOQ. The default value is Days of Cover.",
            "nullable":true,
            "x-queryable":true
        },
        "MaxOverride":{
            "type":"integer",
            "description":"Manual override value of the maximum quantity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "MaxCalcMethod"
                ]
            },
            "x-queryable":true
        },
        "MaxQty":{
            "type":"integer",
            "description":"Value of the maximum quantity.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "MaxCalcMethod",
                    "MaxOverride"
                ]
            },
            "x-queryable":true
        },
        "MinOverride":{
            "type":"integer",
            "description":"Manual override value of the minimum quantity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the object has been updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "OrdQty":{
            "type":"integer",
            "description":"Value of order quantity.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "MaxCalcMethod",
                    "MaxOverride"
                ]
            },
            "x-queryable":true
        },
        "ParTimePeriod":{
            "type":"number",
            "description":"Value of the PAR time period.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PolicyType"
                ]
            },
            "x-queryable":true
        },
        "PolicyCode":{
            "maxLength":120,
            "type":"string",
            "description":"Code of the policy profile.",
            "nullable":true,
            "x-queryable":true
        },
        "PolicyDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the policy profile.",
            "nullable":true,
            "x-queryable":true
        },
        "PolicyId":{
            "type":"integer",
            "description":"Unique identifier of the policy profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PolicyProfileName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the policy profile.",
            "nullable":false,
            "x-queryable":true
        },
        "PolicySpec":{
            "type":"integer",
            "description":"Code of the policy unit of measure.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "PolicyType":{
            "type":"integer",
            "description":"Code of the policy type.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "PolicyTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Type of policy.",
            "nullable":true,
            "x-queryable":true
        },
        "PolicyUnitsSpecName":{
            "maxLength":255,
            "type":"string",
            "description":"Policy unit of measure type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SSCalcMethodName":{
            "maxLength":255,
            "type":"string",
            "description":"Method used to calculate the safety stock.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SsCalcMethod":{
            "type":"integer",
            "description":"Code of the safety stock calculation method.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "SsDaysOfCoverage":{
            "type":"integer",
            "description":"Value that indicates the safety stock days of cover.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "MinOverride",
                    "SsOverride"
                ]
            },
            "x-queryable":true
        },
        "SsOverride":{
            "type":"integer",
            "description":"Manual override value defined for the safety stock.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "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