Jump to

• Request
• Response

Create policy assignment sets

post

/fscmRestApi/resources/11.13.18.05/supplyPlanPolicyAssignSets

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

• Description: string
  Maximum Length: 240

  Description of the policy assignment set.
• ObjectVersionNumber: integer (int32)
  Unique identifier of whether the table row has been updated.
• PolicyAssignmentSetDuplicate: array Duplicate Policy Assignment Sets
  Title: Duplicate Policy Assignment Sets

  Duplicate supply planning policy assignment set serves as a copy of policy associations, often used for scenarios requiring alternate planning strategies or testing different policy configurations within a supply plan.
• PolicySetId: integer (int64)
  Unique identifier of the policy assignment set primary key.
• PolicySetName(required): string
  Maximum Length: 120

  Unique identifier of the policy assignment set name.
• SegmentGroupId(required): integer (int64)
  Unique identifier of the policy assignment segment group.
• SegmentLevelParameters: array Segment Level Parameters
  Title: Segment Level Parameters

  Segment-level policy assignment sets capture specific planning policy assignments at different segments, enabling granular control over supply planning strategies based on product or location hierarchies.

{
    "required":[
        "PolicySetName",
        "SegmentGroupId"
    ],
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the policy assignment set.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Unique identifier of whether the table row has been updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "PolicyAssignmentSetDuplicate":{
            "title":"Duplicate Policy Assignment Sets",
            "type":"array",
            "description":"Duplicate supply planning policy assignment set serves as a copy of policy associations, often used for scenarios requiring alternate planning strategies or testing different policy configurations within a supply plan.",
            "items":{
                "$ref":"#/components/schemas/supplyPlanPolicyAssignSets-PolicyAssignmentSetDuplicate-item-post-request"
            }
        },
        "PolicySetId":{
            "type":"integer",
            "description":"Unique identifier of the policy assignment set primary key.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PolicySetName":{
            "maxLength":120,
            "type":"string",
            "description":"Unique identifier of the policy assignment set name.",
            "nullable":false
        },
        "SegmentGroupId":{
            "type":"integer",
            "description":"Unique identifier of the policy assignment segment group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SegmentLevelParameters":{
            "title":"Segment Level Parameters",
            "type":"array",
            "description":"Segment-level policy assignment sets capture specific planning policy assignments at different segments, enabling granular control over supply planning strategies based on product or location hierarchies.",
            "items":{
                "$ref":"#/components/schemas/supplyPlanPolicyAssignSets-SegmentLevelParameters-item-post-request"
            }
        }
    }
}

Nested Schema : Duplicate Policy Assignment Sets

Type: array

Title: Duplicate Policy Assignment Sets

Duplicate supply planning policy assignment set serves as a copy of policy associations, often used for scenarios requiring alternate planning strategies or testing different policy configurations within a supply plan.

Show Source

• Array of: object supplyPlanPolicyAssignSets-PolicyAssignmentSetDuplicate-item-post-request

{
    "title":"Duplicate Policy Assignment Sets",
    "type":"array",
    "description":"Duplicate supply planning policy assignment set serves as a copy of policy associations, often used for scenarios requiring alternate planning strategies or testing different policy configurations within a supply plan.",
    "items":{
        "$ref":"#/components/schemas/supplyPlanPolicyAssignSets-PolicyAssignmentSetDuplicate-item-post-request"
    }
}

Nested Schema : Segment Level Parameters

Type: array

Title: Segment Level Parameters

Segment-level policy assignment sets capture specific planning policy assignments at different segments, enabling granular control over supply planning strategies based on product or location hierarchies.

Show Source

• Array of: object schema

{
    "title":"Segment Level Parameters",
    "type":"array",
    "description":"Segment-level policy assignment sets capture specific planning policy assignments at different segments, enabling granular control over supply planning strategies based on product or location hierarchies.",
    "items":{
        "$ref":"#/components/schemas/supplyPlanPolicyAssignSets-SegmentLevelParameters-item-post-request"
    }
}

Nested Schema : supplyPlanPolicyAssignSets-PolicyAssignmentSetDuplicate-item-post-request

Type: object

Show Source

• Message: string
  Maximum Length: 255

  Message displayed when duplicate action is performed.
• NewDescription: string
  Description of the duplicated policy assignment set.
• NewPolicySetId: integer
  Unique identifier of the duplicated policy assignment set primary key.
• NewPolicySetName: string
  Name of the duplicated policy assignment set.

{
    "type":"object",
    "properties":{
        "Message":{
            "maxLength":255,
            "type":"string",
            "description":"Message displayed when duplicate action is performed.",
            "nullable":true
        },
        "NewDescription":{
            "type":"string",
            "description":"Description of the duplicated policy assignment set.",
            "nullable":true
        },
        "NewPolicySetId":{
            "type":"integer",
            "description":"Unique identifier of the duplicated policy assignment set primary key.",
            "nullable":true
        },
        "NewPolicySetName":{
            "type":"string",
            "description":"Name of the duplicated policy assignment set.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• Description: string
  Maximum Length: 255

  Segment Level Parameters
• ObjectVersionNumber: integer (int32)
  Unique identifier of whether the segment level parameters have been updated.
• PolicySetId: integer (int64)
  Unique identifier of the policy assignment set primary key which includes the segment level parameters.
• SegmentId: integer (int64)
  Unique identifier of the policy assignment set segment primary key.
• SegmentName: string
  Maximum Length: 255

  Segment Level Parameters
• ServiceLevelPercent: number
  Service level percentage associated with the segment level parameters.

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":255,
            "type":"string",
            "description":"Segment Level Parameters",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Unique identifier of whether the segment level parameters have been updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "PolicySetId":{
            "type":"integer",
            "description":"Unique identifier of the policy assignment set primary key which includes the segment level parameters.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SegmentId":{
            "type":"integer",
            "description":"Unique identifier of the policy assignment set segment primary key.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SegmentName":{
            "maxLength":255,
            "type":"string",
            "description":"Segment Level Parameters",
            "nullable":true
        },
        "ServiceLevelPercent":{
            "type":"number",
            "description":"Service level percentage associated with the segment level parameters.",
            "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 : supplyPlanPolicyAssignSets-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Unique identifier of the user who created the policy assignment set.
• CreationDate: string (date-time)
  Read Only: true

  Date when the policy assignment set was created.
• Description: string
  Maximum Length: 240

  Description of the policy assignment set.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the policy assignment set was updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Last user who updated the policy assignment set.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Last login used to update the policy assignment set.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Unique identifier of whether the table row has been updated.
• PolicyAssignmentSetDuplicate: array Duplicate Policy Assignment Sets
  Title: Duplicate Policy Assignment Sets

  Duplicate supply planning policy assignment set serves as a copy of policy associations, often used for scenarios requiring alternate planning strategies or testing different policy configurations within a supply plan.
• PolicySetId: integer (int64)
  Unique identifier of the policy assignment set primary key.
• PolicySetName: string
  Maximum Length: 120

  Unique identifier of the policy assignment set name.
• SegmentGroupId: integer (int64)
  Unique identifier of the policy assignment segment group.
• SegmentGroupName: string
  Read Only: true

  Maximum Length: 255

  Unique identifier of the segment group name.
• SegmentLevelParameters: array Segment Level Parameters
  Title: Segment Level Parameters

  Segment-level policy assignment sets capture specific planning policy assignments at different segments, enabling granular control over supply planning strategies based on product or location hierarchies.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Unique identifier of the user who created the policy assignment set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the policy assignment set was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the policy assignment set.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the policy assignment set was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last login used to update the policy assignment set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Last user who updated the policy assignment set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Unique identifier of whether the table row has been updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PolicyAssignmentSetDuplicate":{
            "title":"Duplicate Policy Assignment Sets",
            "type":"array",
            "description":"Duplicate supply planning policy assignment set serves as a copy of policy associations, often used for scenarios requiring alternate planning strategies or testing different policy configurations within a supply plan.",
            "items":{
                "$ref":"#/components/schemas/supplyPlanPolicyAssignSets-PolicyAssignmentSetDuplicate-item-response"
            }
        },
        "PolicySetId":{
            "type":"integer",
            "description":"Unique identifier of the policy assignment set primary key.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PolicySetName":{
            "maxLength":120,
            "type":"string",
            "description":"Unique identifier of the policy assignment set name.",
            "nullable":false,
            "x-queryable":true
        },
        "SegmentGroupId":{
            "type":"integer",
            "description":"Unique identifier of the policy assignment segment group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SegmentGroupName":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the segment group name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentLevelParameters":{
            "title":"Segment Level Parameters",
            "type":"array",
            "description":"Segment-level policy assignment sets capture specific planning policy assignments at different segments, enabling granular control over supply planning strategies based on product or location hierarchies.",
            "items":{
                "$ref":"#/components/schemas/supplyPlanPolicyAssignSets-SegmentLevelParameters-item-response"
            }
        },
        "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 : Duplicate Policy Assignment Sets

Type: array

Title: Duplicate Policy Assignment Sets

Duplicate supply planning policy assignment set serves as a copy of policy associations, often used for scenarios requiring alternate planning strategies or testing different policy configurations within a supply plan.

Show Source

• Array of: object supplyPlanPolicyAssignSets-PolicyAssignmentSetDuplicate-item-response

{
    "title":"Duplicate Policy Assignment Sets",
    "type":"array",
    "description":"Duplicate supply planning policy assignment set serves as a copy of policy associations, often used for scenarios requiring alternate planning strategies or testing different policy configurations within a supply plan.",
    "items":{
        "$ref":"#/components/schemas/supplyPlanPolicyAssignSets-PolicyAssignmentSetDuplicate-item-response"
    }
}

Nested Schema : Segment Level Parameters

Type: array

Title: Segment Level Parameters

Segment-level policy assignment sets capture specific planning policy assignments at different segments, enabling granular control over supply planning strategies based on product or location hierarchies.

Show Source

• Array of: object supplyPlanPolicyAssignSets-SegmentLevelParameters-item-response

{
    "title":"Segment Level Parameters",
    "type":"array",
    "description":"Segment-level policy assignment sets capture specific planning policy assignments at different segments, enabling granular control over supply planning strategies based on product or location hierarchies.",
    "items":{
        "$ref":"#/components/schemas/supplyPlanPolicyAssignSets-SegmentLevelParameters-item-response"
    }
}

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."
        }
    }
}

Nested Schema : supplyPlanPolicyAssignSets-PolicyAssignmentSetDuplicate-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Message: string
  Maximum Length: 255

  Message displayed when duplicate action is performed.
• NewDescription: string
  Description of the duplicated policy assignment set.
• NewPolicySetId: integer
  Unique identifier of the duplicated policy assignment set primary key.
• NewPolicySetName: string
  Name of the duplicated policy assignment set.

{
    "type":"object",
    "properties":{
        "Message":{
            "maxLength":255,
            "type":"string",
            "description":"Message displayed when duplicate action is performed.",
            "nullable":true,
            "x-queryable":true
        },
        "NewDescription":{
            "type":"string",
            "description":"Description of the duplicated policy assignment set.",
            "nullable":true,
            "x-queryable":true
        },
        "NewPolicySetId":{
            "type":"integer",
            "description":"Unique identifier of the duplicated policy assignment set primary key.",
            "nullable":true,
            "x-queryable":true
        },
        "NewPolicySetName":{
            "type":"string",
            "description":"Name of the duplicated policy assignment set.",
            "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 : supplyPlanPolicyAssignSets-SegmentLevelParameters-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Unique identifier of the user who created the segment level parameters of the policy assignment set.
• CreationDate: string (date-time)
  Read Only: true

  Date when the segment level parameters of the policy assignment set were created.
• Description: string
  Maximum Length: 255

  Segment Level Parameters
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the segment level parameters of the policy assignment set were last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Last user who updated the policy assignment set segment level parameters.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login used to update the segment level parameters of the policy assignment set.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Unique identifier of whether the segment level parameters have been updated.
• PolicySetId: integer (int64)
  Unique identifier of the policy assignment set primary key which includes the segment level parameters.
• SegmentId: integer (int64)
  Unique identifier of the policy assignment set segment primary key.
• SegmentName: string
  Maximum Length: 255

  Segment Level Parameters
• ServiceLevelPercent: number
  Service level percentage associated with the segment level parameters.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Unique identifier of the user who created the segment level parameters of the policy assignment set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the segment level parameters of the policy assignment set were created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":255,
            "type":"string",
            "description":"Segment Level Parameters",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the segment level parameters of the policy assignment set were last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login used to update the segment level parameters of the policy assignment set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Last user who updated the policy assignment set segment level parameters.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Unique identifier of whether the segment level parameters have been updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PolicySetId":{
            "type":"integer",
            "description":"Unique identifier of the policy assignment set primary key which includes the segment level parameters.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SegmentId":{
            "type":"integer",
            "description":"Unique identifier of the policy assignment set segment primary key.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SegmentName":{
            "maxLength":255,
            "type":"string",
            "description":"Segment Level Parameters",
            "nullable":true,
            "x-queryable":true
        },
        "ServiceLevelPercent":{
            "type":"number",
            "description":"Service level percentage associated with the segment level parameters.",
            "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"
    }
}

Links

PolicyAssignmentSetDuplicate

Operation: /fscmRestApi/resources/11.13.18.05/supplyPlanPolicyAssignSets/{PolicySetId}/child/PolicyAssignmentSetDuplicate

Parameters:

• PolicySetId: $request.path.PolicySetId

Duplicate supply planning policy assignment set serves as a copy of policy associations, often used for scenarios requiring alternate planning strategies or testing different policy configurations within a supply plan.

SegmentLevelParameters

Operation: /fscmRestApi/resources/11.13.18.05/supplyPlanPolicyAssignSets/{PolicySetId}/child/SegmentLevelParameters

Parameters:

• PolicySetId: $request.path.PolicySetId

Segment-level policy assignment sets capture specific planning policy assignments at different segments, enabling granular control over supply planning strategies based on product or location hierarchies.

Back to Top