Jump to

• Request
• Response

Update one policy assignment

patch

/fscmRestApi/resources/11.13.18.05/minMaxPolicyAssignments/{AssociationId}

Request

Path Parameters

• AssociationId(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: 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

• AssociationId: integer (int64)
  Value that uniquely identifies the policy assignment.
• ClassificationCode: string
  Maximum Length: 120

  Code that identifies the classification.
• ClassificationId: integer (int64)
  Value that uniquely identifies the classification.
• GroupCode: string
  Maximum Length: 120

  Code that identifies the classification group.
• GroupId: integer (int64)
  Value that uniquely identifies the classification group.
• IncludeInCal: integer (int32)
  Value that specifies whether the policy assignment is included in policy calculations.
• ObjectVersionNumber: integer (int32)
  Number of times the object has been updated.
• OrgAndSubInventories: array Policy Assignments for Organizations and Subinventories
  Title: Policy Assignments for Organizations and Subinventories

  Policy assignments for organizations and subinventories.
• Organizations: string
  Maximum Length: 255

  Name of the organization.
• OrganizationsIds: string
  Maximum Length: 255

  Value that uniquely identifies the organization.
• PolicyCode: string
  Maximum Length: 120

  Code that identifies the policy.
• PolicyId: integer (int64)
  Value that uniquely identifies the policy.
• SubInventories: string
  Maximum Length: 255

  Name of the subinventories.
• SubInventoriesIds: string
  Maximum Length: 255

  Value that uniquely identifies the subinventories.

{
    "type":"object",
    "properties":{
        "AssociationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the policy assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ClassificationCode":{
            "maxLength":120,
            "type":"string",
            "description":"Code that identifies the classification.",
            "nullable":true
        },
        "ClassificationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the classification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "GroupCode":{
            "maxLength":120,
            "type":"string",
            "description":"Code that identifies the classification group.",
            "nullable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the classification group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "IncludeInCal":{
            "type":"integer",
            "description":"Value that specifies whether the policy assignment is included in policy calculations.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the object has been updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "OrgAndSubInventories":{
            "title":"Policy Assignments for Organizations and Subinventories",
            "type":"array",
            "description":"Policy assignments for organizations and subinventories.",
            "items":{
                "$ref":"#/components/schemas/minMaxPolicyAssignments-OrgAndSubInventories-item-patch-request"
            }
        },
        "Organizations":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the organization.",
            "nullable":true
        },
        "OrganizationsIds":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the organization.",
            "nullable":true
        },
        "PolicyCode":{
            "maxLength":120,
            "type":"string",
            "description":"Code that identifies the policy.",
            "nullable":true
        },
        "PolicyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the policy.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SubInventories":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the subinventories.",
            "nullable":true
        },
        "SubInventoriesIds":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the subinventories.",
            "nullable":true
        }
    }
}

Nested Schema : Policy Assignments for Organizations and Subinventories

Type: array

Title: Policy Assignments for Organizations and Subinventories

Policy assignments for organizations and subinventories.

Show Source

• Array of: object minMaxPolicyAssignments-OrgAndSubInventories-item-patch-request

{
    "title":"Policy Assignments for Organizations and Subinventories",
    "type":"array",
    "description":"Policy assignments for organizations and subinventories.",
    "items":{
        "$ref":"#/components/schemas/minMaxPolicyAssignments-OrgAndSubInventories-item-patch-request"
    }
}

Nested Schema : minMaxPolicyAssignments-OrgAndSubInventories-item-patch-request

Type: object

Show Source

• AssociationEntityId: integer (int64)
  Value that uniquely identifies the policy assignment entity.
• AssociationId: integer (int64)
  Value that uniquely identifies the policy assignment.
• ObjectVersionNumber: integer (int32)
  Number of times the object has been updated.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organizations.
• SubinventoryId: integer (int64)
  Value that uniquely identifies the subinventories.

{
    "type":"object",
    "properties":{
        "AssociationEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the policy assignment entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AssociationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the policy assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the object has been updated.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organizations.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SubinventoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the subinventories.",
            "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 : minMaxPolicyAssignments-item-response

Type: object

Show Source

• AssociationId: integer (int64)
  Value that uniquely identifies the policy assignment.
• ClassificationCode: string
  Maximum Length: 120

  Code that identifies the classification.
• ClassificationId: integer (int64)
  Value that uniquely identifies the classification.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date when the user created the policy assignment.
• GroupCode: string
  Maximum Length: 120

  Code that identifies the classification group.
• GroupId: integer (int64)
  Value that uniquely identifies the classification group.
• IncludeInCal: integer (int32)
  Value that specifies whether the policy assignment is included in policy calculations.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  User who most recently updated the policy assignment.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login used by the user to update the policy assignment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Number of times the object has been updated.
• OrgAndSubInventories: array Policy Assignments for Organizations and Subinventories
  Title: Policy Assignments for Organizations and Subinventories

  Policy assignments for organizations and subinventories.
• Organizations: string
  Maximum Length: 255

  Name of the organization.
• OrganizationsIds: string
  Maximum Length: 255

  Value that uniquely identifies the organization.
• PolicyCode: string
  Maximum Length: 120

  Code that identifies the policy.
• PolicyId: integer (int64)
  Value that uniquely identifies the policy.
• SubInventories: string
  Maximum Length: 255

  Name of the subinventories.
• SubInventoriesIds: string
  Maximum Length: 255

  Value that uniquely identifies the subinventories.

{
    "type":"object",
    "properties":{
        "AssociationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the policy assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClassificationCode":{
            "maxLength":120,
            "type":"string",
            "description":"Code that identifies the classification.",
            "nullable":true,
            "x-queryable":true
        },
        "ClassificationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the classification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the policy assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the policy assignment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupCode":{
            "maxLength":120,
            "type":"string",
            "description":"Code that identifies the classification group.",
            "nullable":true,
            "x-queryable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the classification group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IncludeInCal":{
            "type":"integer",
            "description":"Value that specifies whether the policy assignment is included in policy calculations.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user updated the policy assignment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login used by the user to update the policy assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the policy assignment.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "OrgAndSubInventories":{
            "title":"Policy Assignments for Organizations and Subinventories",
            "type":"array",
            "description":"Policy assignments for organizations and subinventories.",
            "items":{
                "$ref":"#/components/schemas/minMaxPolicyAssignments-OrgAndSubInventories-item-response"
            }
        },
        "Organizations":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationsIds":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "PolicyCode":{
            "maxLength":120,
            "type":"string",
            "description":"Code that identifies the policy.",
            "nullable":true,
            "x-queryable":true
        },
        "PolicyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the policy.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubInventories":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the subinventories.",
            "nullable":true,
            "x-queryable":true
        },
        "SubInventoriesIds":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the subinventories.",
            "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 : Policy Assignments for Organizations and Subinventories

Type: array

Title: Policy Assignments for Organizations and Subinventories

Policy assignments for organizations and subinventories.

Show Source

• Array of: object minMaxPolicyAssignments-OrgAndSubInventories-item-response

{
    "title":"Policy Assignments for Organizations and Subinventories",
    "type":"array",
    "description":"Policy assignments for organizations and subinventories.",
    "items":{
        "$ref":"#/components/schemas/minMaxPolicyAssignments-OrgAndSubInventories-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 : minMaxPolicyAssignments-OrgAndSubInventories-item-response

Type: object

Show Source

• AssociationEntityId: integer (int64)
  Value that uniquely identifies the policy assignment entity.
• AssociationId: integer (int64)
  Value that uniquely identifies the policy assignment.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the policy assignments for organization and subinventory.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the policy assignment for the organization and subinventory.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user updated the policy assignment for the organization and subinventory.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the policy assignment for the organization and subinventory.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login used by the user to update the policy assignment for the organization and subinventory.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Number of times the object has been updated.
• OrganizationCode: string
  Read Only: true

  Maximum Length: 255

  Code that identifies the organization.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organizations.
• SubinventoryCode: string
  Read Only: true

  Maximum Length: 255

  Code that identifies the subinventory.
• SubinventoryId: integer (int64)
  Value that uniquely identifies the subinventories.

{
    "type":"object",
    "properties":{
        "AssociationEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the policy assignment entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssociationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the policy assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the policy assignments for organization and subinventory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the policy assignment for the organization and subinventory.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user updated the policy assignment for the organization and subinventory.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login used by the user to update the policy assignment for the organization and subinventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the policy assignment for the organization and subinventory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the object has been updated.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Code that identifies the organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organizations.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubinventoryCode":{
            "maxLength":255,
            "type":"string",
            "description":"Code that identifies the subinventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubinventoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the subinventories.",
            "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"
    }
}

Links

OrgAndSubInventories

Operation: /fscmRestApi/resources/11.13.18.05/minMaxPolicyAssignments/{AssociationId}/child/OrgAndSubInventories

Parameters:

• AssociationId: $request.path.AssociationId

Policy assignments for organizations and subinventories.

Back to Top