Add a component
post
/fscmRestApi/resources/11.13.18.05/deleteGroups/{DeleteGroupSequenceId}/child/components
Request
Path Parameters
-
DeleteGroupSequenceId(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:
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
Root Schema : schema
Type:
Show Source
object
-
BillSequenceId: integer
(int64)
Value that uniquely identifies the structure to which the component belongs.
-
Component: string
Maximum Length:
255
Name of the component. -
ComponentDescription: string
Maximum Length:
255
Description of the component item. -
ComponentSequenceId: integer
(int64)
Value that uniquely identifies a component in a structure.
-
DeleteEntitySequenceId: integer
(int64)
Value that uniquely identifies a component in a delete group.
-
DeleteGroupSequenceId(required): integer
(int64)
Value that uniquely identifies the delete group to which the component belongs.
-
DeleteStatusTypeName: string
Maximum Length:
255
Deletion status of the component. -
errors: array
Errors
Title:
Errors
Errors encountered during the deletion of a particular entity in a delete group. -
Organization: string
Maximum Length:
255
Abbreviation that identifies the organization to which the component belongs. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization to which the component belongs.
-
ParentItem: string
Maximum Length:
255
Name of the item to which the component belongs. -
ParentItemDescription: string
Maximum Length:
255
Description of the item to which the component belongs. -
ParentItemId: integer
(int64)
Value that uniquely identifies the item to which the component belongs.
-
Structure: string
Maximum Length:
255
Name of the structure to which the component belongs.
Nested Schema : Errors
Type:
array
Title:
Errors
Errors encountered during the deletion of a particular entity in a delete group.
Show Source
Nested Schema : deleteGroups-components-errors-item-post-request
Type:
Show Source
object
-
DeleteEntitySequenceId: integer
(int64)
Value that uniquely identifies the delete group entity for which the error has been encountered.
-
ErrorCode: string
Title:
Code
Maximum Length:100
Number of the error message encountered while deleting an entity in a delete group. -
ErrorMessage: string
Title:
Message
Maximum Length:4000
Error message encountered while deleting an entity in a delete 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 : deleteGroups-components-item-response
Type:
Show Source
object
-
BillSequenceId: integer
(int64)
Value that uniquely identifies the structure to which the component belongs.
-
Component: string
Maximum Length:
255
Name of the component. -
ComponentDescription: string
Maximum Length:
255
Description of the component item. -
ComponentSequenceId: integer
(int64)
Value that uniquely identifies a component in a structure.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the component. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the component. -
DeleteEntitySequenceId: integer
(int64)
Value that uniquely identifies a component in a delete group.
-
DeleteGroupSequenceId: integer
(int64)
Value that uniquely identifies the delete group to which the component belongs.
-
DeleteStatusType: integer
(int32)
Title:
Status
Read Only:true
Default Value:1
Value that uniquely identifies the deletion status of the component. -
DeleteStatusTypeName: string
Maximum Length:
255
Deletion status of the component. -
errors: array
Errors
Title:
Errors
Errors encountered during the deletion of a particular entity in a delete group. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the component. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the component. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the component. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Organization: string
Maximum Length:
255
Abbreviation that identifies the organization to which the component belongs. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization to which the component belongs.
-
ParentItem: string
Maximum Length:
255
Name of the item to which the component belongs. -
ParentItemDescription: string
Maximum Length:
255
Description of the item to which the component belongs. -
ParentItemId: integer
(int64)
Value that uniquely identifies the item to which the component belongs.
-
Structure: string
Maximum Length:
255
Name of the structure to which the component belongs.
Nested Schema : Errors
Type:
array
Title:
Errors
Errors encountered during the deletion of a particular entity in a delete group.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : deleteGroups-components-errors-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the delete group entity for which the error has been encountered. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the delete group entity for which the error has been encountered. -
DeleteEntitySequenceId: integer
(int64)
Value that uniquely identifies the delete group entity for which the error has been encountered.
-
ErrorCode: string
Title:
Code
Maximum Length:100
Number of the error message encountered while deleting an entity in a delete group. -
ErrorMessage: string
Title:
Message
Maximum Length:4000
Error message encountered while deleting an entity in a delete group. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the delete group entity for which the error has been encountered. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the delete group entity for which the error has been encountered. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the delete group entity for which the error has been encountered. -
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
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.
Links
- errors
-
Parameters:
- DeleteEntitySequenceId2:
$request.path.DeleteEntitySequenceId2
- DeleteGroupSequenceId:
$request.path.DeleteGroupSequenceId
Errors encountered during the deletion of a particular entity in a delete group. - DeleteEntitySequenceId2: