Update one ABC Assignment Group
patch
/fscmRestApi/resources/11.13.18.05/abcAssignmentGroups/{AssignmentGroupId}
Request
Path Parameters
-
AssignmentGroupId(required): integer(int64)
Value that uniquely identifies the ABC Assignment Group.
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
Root Schema : schema
Type:
Show Source
object
-
abcAssignmentGroupAttachments: array
Attachments
Title:
Attachments
It is used to view, create, and update attachments on the ABC Assignment Group. -
abcAssignmentGroupClasses: array
ABC Assignment Group Classes
Title:
ABC Assignment Group Classes
It is a child of the ABC Assignment Groups and is used to view, create, update, and delete the ABC assignment group classes. -
abcAssignmentGroupItems: array
ABC Assignment Group Items
Title:
ABC Assignment Group Items
It is a child of the abcAssignmentGroups and is used to view, create, update, and delete the ABC assignment group items. -
AssignmentGroupName: string
Title:
Assignment Group Name
Maximum Length:40
Name of the ABC Assignment Group. -
CompileId: integer
(int64)
Value that uniquely identifies the classification set used in the ABC Assignment Group.
-
CompileName: string
Maximum Length:
255
Name of the classification set used in the ABC Assignment Group. -
DFF: array
Descriptive Flex Fields
Title:
Descriptive Flex Fields
This descriptive flexfield is for the ABC Assignment Groups and is used to view, create, update, and delete the DFF attributes of ABC assignment group. -
OrganizationCode: string
Maximum Length:
255
Indicates the code for the inventory organization. -
SecondaryInventory: string
Maximum Length:
10
Name of the subinventory assosciated in the classification set. -
ValuationScopeCode: string
Title:
Valuation Scope
Maximum Length:30
Code that indicates the scope of the ABC classification group. Possible values are: 1 - organization wide or 2 - restricted to the specific subinventory.
Nested Schema : Attachments
Type:
array
Title:
Attachments
It is used to view, create, and update attachments on the ABC Assignment Group.
Show Source
Nested Schema : ABC Assignment Group Classes
Type:
array
Title:
ABC Assignment Group Classes
It is a child of the ABC Assignment Groups and is used to view, create, update, and delete the ABC assignment group classes.
Show Source
Nested Schema : ABC Assignment Group Items
Type:
array
Title:
ABC Assignment Group Items
It is a child of the abcAssignmentGroups and is used to view, create, update, and delete the ABC assignment group items.
Show Source
Nested Schema : Descriptive Flex Fields
Type:
array
Title:
Descriptive Flex Fields
This descriptive flexfield is for the ABC Assignment Groups and is used to view, create, update, and delete the DFF attributes of ABC assignment group.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code while creating or updating the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message while creating or updating the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment.
Nested Schema : schema
Type:
Show Source
object
-
AbcClassId: integer
(int64)
Value that uniquely identifies the ABC class assigned to the ABC Assignment Group.
-
AbcClassName: string
Maximum Length:
255
Value that identifies the ABC Class. -
InventoryValue: number
Cummulative value of all items in this ABC assignment group classes.
-
ItemSequenceNumber: integer
(int64)
Title:
Sequence
Sequence number of the last item in the class within the ABC Assignment Group. -
OrganizationCode: string
Maximum Length:
255
Indicates the code of the inventory organization. -
OrganizationId: integer
Value identifies the inventory organization.
-
PercentOfItems: number
Title:
Item Percentage
Percentage of the total number of assignment group items in the ABC assignment group class. -
PercentOfValue: number
Title:
Value Percentage
Percentage of the total inventory value in the ABC assignment group class. -
SequenceNumber: integer
(int64)
Title:
Sequence
Indicates the priority of the classes assigned to the ABC assignment group.
Nested Schema : schema
Type:
Show Source
object
-
AbcClassId: integer
(int64)
Value uniquely identifies the ABC Class assigned to the item in the ABC assignment group.
-
AbcClassName: string
Maximum Length:
255
Indicates the name of the ABC class assigned to the item. -
ItemNumber: string
Maximum Length:
255
Value that identifies the item that is assigned to the ABC Assignment Group Items. -
OrganizationCode: string
Maximum Length:
255
Indicates the code of the inventory organization.
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context
Maximum Length:30
The context of the DFF of the ABC Assigment Group. -
__FLEX_Context_DisplayValue: string
Title:
Context
The display value of the DFF context for the ABC Assigment Group.
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.
Root Schema : abcAssignmentGroups-item-response
Type:
Show Source
object
-
abcAssignmentGroupAttachments: array
Attachments
Title:
Attachments
It is used to view, create, and update attachments on the ABC Assignment Group. -
abcAssignmentGroupClasses: array
ABC Assignment Group Classes
Title:
ABC Assignment Group Classes
It is a child of the ABC Assignment Groups and is used to view, create, update, and delete the ABC assignment group classes. -
abcAssignmentGroupItems: array
ABC Assignment Group Items
Title:
ABC Assignment Group Items
It is a child of the abcAssignmentGroups and is used to view, create, update, and delete the ABC assignment group items. -
AssignmentGroupId: integer
(int64)
Value that uniquely identifies the ABC Assignment Group.
-
AssignmentGroupName: string
Title:
Assignment Group Name
Maximum Length:40
Name of the ABC Assignment Group. -
CompileCriteria: string
Read Only:
true
Maximum Length:255
Value identifies the criteria used for the classification of items in the classification set. -
CompileId: integer
(int64)
Value that uniquely identifies the classification set used in the ABC Assignment Group.
-
CompileItems: integer
Read Only:
true
Value that denotes the number of items in the classification set. -
CompileName: string
Maximum Length:
255
Name of the classification set used in the ABC Assignment Group. -
CreationDate: string
(date-time)
Read Only:
true
Indicates the date and time of the creation of the ABC Assignment Group. -
CumulativeValue: number
Read Only:
true
Total value of all items within the classification set. -
Description: string
Read Only:
true
Maximum Length:255
Description of classification set. -
DFF: array
Descriptive Flex Fields
Title:
Descriptive Flex Fields
This descriptive flexfield is for the ABC Assignment Groups and is used to view, create, update, and delete the DFF attributes of ABC assignment group. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumberOfAssignments: string
Read Only:
true
Value indicates the number of classes assigned to the ABC Assignment Group. -
OrganizationCode: string
Maximum Length:
255
Indicates the code for the inventory organization. -
OrganizationId: integer
(int64)
Value identifies the inventory organization.
-
OrganizationName: string
Read Only:
true
Maximum Length:255
Indicates the name of the inventory organization. -
SecondaryInventory: string
Maximum Length:
10
Name of the subinventory assosciated in the classification set. -
ValuationScope: string
Read Only:
true
Maximum Length:255
Scope of the ABC classification group. Possible values are: organization wide or restricted to the specific subinventory. -
ValuationScopeCode: string
Title:
Valuation Scope
Maximum Length:30
Code that indicates the scope of the ABC classification group. Possible values are: 1 - organization wide or 2 - restricted to the specific subinventory.
Nested Schema : Attachments
Type:
array
Title:
Attachments
It is used to view, create, and update attachments on the ABC Assignment Group.
Show Source
Nested Schema : ABC Assignment Group Classes
Type:
array
Title:
ABC Assignment Group Classes
It is a child of the ABC Assignment Groups and is used to view, create, update, and delete the ABC assignment group classes.
Show Source
Nested Schema : ABC Assignment Group Items
Type:
array
Title:
ABC Assignment Group Items
It is a child of the abcAssignmentGroups and is used to view, create, update, and delete the ABC assignment group items.
Show Source
Nested Schema : Descriptive Flex Fields
Type:
array
Title:
Descriptive Flex Fields
This descriptive flexfield is for the ABC Assignment Groups and is used to view, create, update, and delete the DFF attributes of ABC assignment group.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : abcAssignmentGroups-abcAssignmentGroupAttachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code while creating or updating the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message while creating or updating the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : abcAssignmentGroups-abcAssignmentGroupClasses-item-response
Type:
Show Source
object
-
AbcClassId: integer
(int64)
Value that uniquely identifies the ABC class assigned to the ABC Assignment Group.
-
AbcClassName: string
Maximum Length:
255
Value that identifies the ABC Class. -
AbcGroupClassId: integer
(int64)
Value that uniquely identifies the ABC Assignment Group Class.
-
AssignmentGroupId: integer
(int64)
Value that uniquely identifies the ABC Assignment Group to which the ABC group class is assigned.
-
CreationDate: string
(date-time)
Read Only:
true
Indicates the date and time of the creation of the ABC group class. -
Description: string
Read Only:
true
Maximum Length:255
Description of the ABC Class. -
InventoryValue: number
Cummulative value of all items in this ABC assignment group classes.
-
ItemDescription: string
Read Only:
true
Maximum Length:255
Description of the last item in the current ABC assignment group class. -
ItemNumber: string
Read Only:
true
Maximum Length:255
Indicates the item of the last item in the current ABC assignment group class. -
ItemSequenceNumber: integer
(int64)
Title:
Sequence
Sequence number of the last item in the class within the ABC Assignment Group. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCode: string
Maximum Length:
255
Indicates the code of the inventory organization. -
OrganizationId: integer
Value identifies the inventory organization.
-
PercentOfItems: number
Title:
Item Percentage
Percentage of the total number of assignment group items in the ABC assignment group class. -
PercentOfValue: number
Title:
Value Percentage
Percentage of the total inventory value in the ABC assignment group class. -
SequenceNumber: integer
(int64)
Title:
Sequence
Indicates the priority of the classes assigned to the ABC assignment group.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : abcAssignmentGroups-abcAssignmentGroupItems-item-response
Type:
Show Source
object
-
AbcAssignmentId: integer
(int64)
Value that uniquely identifies the ABC Assignment Item.
-
AbcClassId: integer
(int64)
Value uniquely identifies the ABC Class assigned to the item in the ABC assignment group.
-
AbcClassName: string
Maximum Length:
255
Indicates the name of the ABC class assigned to the item. -
AssignmentGroupId: integer
(int64)
Value that uniquely identifies the ABC Assignment Group for the ABC Assignment items.
-
CreationDate: string
(date-time)
Read Only:
true
Indicates the date and time of the creation of the ABC assigment group item. -
Description: string
Read Only:
true
Maximum Length:255
Description of the ABC Class assigned to the item. -
InventoryItemId: integer
(int64)
Value that uniqely identifies the item that is assigned to the ABC Assignment Group Items.
-
ItemDescription: string
Read Only:
true
Maximum Length:255
Description of the item. -
ItemNumber: string
Maximum Length:
255
Value that identifies the item that is assigned to the ABC Assignment Group Items. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCode: string
Maximum Length:
255
Indicates the code of the inventory organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
OrganizationName: string
Read Only:
true
Maximum Length:255
Indicates the name of the inventory organization. -
SequenceNumber: integer
(int64)
Title:
Sequence
Read Only:true
Sequence number of the last item in the class within the ABC Assignment Group.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : abcAssignmentGroups-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context
Maximum Length:30
The context of the DFF of the ABC Assigment Group. -
__FLEX_Context_DisplayValue: string
Title:
Context
The display value of the DFF context for the ABC Assigment Group. -
AssignmentGroupId: integer
(int64)
Value that uniquely identifies the ABC Assignment Group.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- DFF
-
Parameters:
- AssignmentGroupId:
$request.path.AssignmentGroupId
This descriptive flexfield is for the ABC Assignment Groups and is used to view, create, update, and delete the DFF attributes of ABC assignment group. - AssignmentGroupId:
- abcAssignmentGroupAttachments
-
Parameters:
- AssignmentGroupId:
$request.path.AssignmentGroupId
It is used to view, create, and update attachments on the ABC Assignment Group. - AssignmentGroupId:
- abcAssignmentGroupClasses
-
Parameters:
- AssignmentGroupId:
$request.path.AssignmentGroupId
It is a child of the ABC Assignment Groups and is used to view, create, update, and delete the ABC assignment group classes. - AssignmentGroupId:
- abcAssignmentGroupItems
-
Parameters:
- AssignmentGroupId:
$request.path.AssignmentGroupId
It is a child of the abcAssignmentGroups and is used to view, create, update, and delete the ABC assignment group items. - AssignmentGroupId: