Jump to

• Request
• Response

Update one association

patch

/fscmRestApi/resources/11.13.18.05/itemsV2/{itemsV2UniqID}/child/ItemCategory/{ItemCategoryAssignmentId}

Request

Path Parameters

• ItemCategoryAssignmentId(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=
• itemsV2UniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Items Version 2 resource and used to uniquely identify an instance of Items Version 2. The client should not generate the hash key value. Instead, the client should query on the Items Version 2 collection resource in order to navigate to a specific instance of Items Version 2 to get the hash key.

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

• CategoryCode: string
  Maximum Length: 255

  A unique code that represents a component of the catalog used for classification of items.
• CategoryName: string
  Name of the category.
• EndDate: string (date)
  Date when the item association ends. The end date can't be specified for functional area catalogs, except for the catalog assigned to the service logistics functional area.
• ItemCatalog: string
  Name of the item catalog.
• RequestId: integer (int64)
  The request ID generated at import. Its use case is to verify the import. The items are published based on RequestID.
• SequenceNumber: integer (int32)
  Value that indicates the sequence number of the item category assignments.
• StartDate: string (date)
  Date when the item association begins. The start date can't be specified for functional area catalogs, except for the catalog assigned to the service logistics functional area.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "maxLength":255,
            "type":"string",
            "description":"A unique code that represents a component of the catalog used for classification of items.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CategoryName":{
            "type":"string",
            "description":"Name of the category.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the item association ends. The end date can't be specified for functional area catalogs, except for the catalog assigned to the service logistics functional area.",
            "format":"date",
            "nullable":true
        },
        "ItemCatalog":{
            "type":"string",
            "description":"Name of the item catalog.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RequestId":{
            "type":"integer",
            "description":"The request ID generated at import. Its use case is to verify the import. The items are published based on RequestID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Value that indicates the sequence number of the item category assignments.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the item association begins. The start date can't be specified for functional area catalogs, except for the catalog assigned to the service logistics functional area.",
            "format":"date",
            "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 : itemsV2-ItemCategory-item-response

Type: object

Show Source

• CategoryCode: string
  Maximum Length: 255

  A unique code that represents a component of the catalog used for classification of items.
• CategoryName: string
  Name of the category.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the item category assignment.
• CreationDateTime: string (date-time)
  Read Only: true

  Date and time of the creation of the item catalog category assignment.
• EndDate: string (date)
  Date when the item association ends. The end date can't be specified for functional area catalogs, except for the catalog assigned to the service logistics functional area.
• ItemCatalog: string
  Name of the item catalog.
• ItemCategoryAssignmentId: integer (int64)
  Value that uniquely identifies the item category assignment.
• ItemCategoryHierarchyCode: string
  Read Only: true

  Value that represents category hierarchy using category codes.
• ItemCategoryHierarchyName: string
  Read Only: true

  Value that represents category hierarchy using category names.
• ItemId: integer (int64)
  Value that uniquely identifies the part, item, product, or service.
• LastUpdateDateTime: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the item-category association.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the item-category association.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the item-category association..
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationId: integer (int64)
  Read Only: true

  A unique identifier for an organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting.
• RequestId: integer (int64)
  The request ID generated at import. Its use case is to verify the import. The items are published based on RequestID.
• SequenceNumber: integer (int32)
  Value that indicates the sequence number of the item category assignments.
• StartDate: string (date)
  Date when the item association begins. The start date can't be specified for functional area catalogs, except for the catalog assigned to the service logistics functional area.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "maxLength":255,
            "type":"string",
            "description":"A unique code that represents a component of the catalog used for classification of items.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "type":"string",
            "description":"Name of the category.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the item category assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date and time of the creation of the item catalog category assignment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the item association ends. The end date can't be specified for functional area catalogs, except for the catalog assigned to the service logistics functional area.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ItemCatalog":{
            "type":"string",
            "description":"Name of the item catalog.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemCategoryAssignmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item category assignment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemCategoryHierarchyCode":{
            "type":"string",
            "description":"Value that represents category hierarchy using category codes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemCategoryHierarchyName":{
            "type":"string",
            "description":"Value that represents category hierarchy using category names.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the part, item, product, or service.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date and time when the user most recently updated the item-category association.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the item-category association..",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the item-category association.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"A unique identifier for an organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestId":{
            "type":"integer",
            "description":"The request ID generated at import. Its use case is to verify the import. The items are published based on RequestID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Value that indicates the sequence number of the item category assignments.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the item association begins. The start date can't be specified for functional area catalogs, except for the catalog assigned to the service logistics functional area.",
            "format":"date",
            "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