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)
  Value that uniquely identifies the item category assignment.
• 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:
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CategoryCode: string
  Maximum Length: 255

  Abbreviation that identifies the item category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage catalogs task.
• CategoryName: string
  Name of the item category.
• EndDate: string (date)
  Date when the item association ends. The end date cannot 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)
  Value that uniquely identifies the request. This attribute is generated during import. This value is used to verify import, when items are published.
• SequenceNumber: integer (int32)
  Not exposed in code.
• StartDate: string (date)
  Date when the item association begins. The start date cannot be specified for functional area catalogs, except for the catalog assigned to the service logistics functional area.

{
    "type":"object",
    "properties":{
        "ItemCatalog":{
            "type":"string",
            "description":"Name of the item catalog.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CategoryCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the item category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage catalogs task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the item association begins. The start date cannot be specified for functional area catalogs, except for the catalog assigned to the service logistics functional area.",
            "format":"date",
            "nullable":true
        },
        "RequestId":{
            "type":"integer",
            "description":"Value that uniquely identifies the request. This attribute is generated during import. This value is used to verify import, when items are published.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Not exposed in code.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            }
        },
        "CategoryName":{
            "type":"string",
            "description":"Name of the item category.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the item association ends. The end date cannot 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

  Abbreviation that identifies the item category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage catalogs task.
• CategoryName: string
  Name of the item category.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the user created the item-category association.
• EndDate: string (date)
  Date when the item association ends. The end date cannot 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

  Not exposed in code.
• ItemCategoryHierarchyName: string
  Read Only: true

  Not exposed in code.
• 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.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

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

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

  Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
• RequestId: integer (int64)
  Value that uniquely identifies the request. This attribute is generated during import. This value is used to verify import, when items are published.
• SequenceNumber: integer (int32)
  Not exposed in code.
• StartDate: string (date)
  Date when the item association begins. The start date cannot be specified for functional area catalogs, except for the catalog assigned to the service logistics functional area.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the item category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage catalogs task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the item.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "RequestId":{
            "type":"integer",
            "description":"Value that uniquely identifies the request. This attribute is generated during import. This value is used to verify import, when items are published.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemCategoryHierarchyName":{
            "type":"string",
            "description":"Not exposed in code.",
            "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
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the item association ends. The end date cannot be specified for functional area catalogs, except for the catalog assigned to the service logistics functional area.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ItemCategoryHierarchyCode":{
            "type":"string",
            "description":"Not exposed in code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemCatalog":{
            "type":"string",
            "description":"Name of the item catalog.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the item association begins. The start date cannot be specified for functional area catalogs, except for the catalog assigned to the service logistics functional area.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date and time when the user created the item-category association.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Not exposed in code.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "type":"string",
            "description":"Name of the item category.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Login that the user used when updating the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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