Jump to

• Request
• Response

Update policy assignment set segment level parameters

patch

/fscmRestApi/resources/11.13.18.05/supplyPlanPolicyAssignSets/{PolicySetId}/child/SegmentLevelParameters/{SegmentLevelParametersUniqID}

Request

Path Parameters

• PolicySetId(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=
• SegmentLevelParametersUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PolicySetId and SegmentId ---for the Segment Level Parameters resource and used to uniquely identify an instance of Segment Level Parameters. The client should not generate the hash key value. Instead, the client should query on the Segment Level Parameters collection resource with a filter on the primary key values in order to navigate to a specific instance of Segment Level Parameters.
  
  For example: SegmentLevelParameters?q=PolicySetId=<value1>;SegmentId=<value2>

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

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