Jump to

• Request
• Response

Get one delete group

get

/fscmRestApi/resources/11.13.18.05/deleteGroups/{DeleteGroupSequenceId}

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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : deleteGroups-item-response

Type: object

Show Source

• changeOrders: array Change Orders
  Title: Change Orders

  Change orders let you process changes to user-defined item attributes, structures, packs, associations, and item revisions. A change order can be added to a delete group for deletion.
• components: array Components
  Title: Components

  Item structure components added to a delete group for deletion.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date when the user created the delete group.
• DateLastSubmitted: string (date-time)
  Title: Last Submission Date

  Date when the entities in the delete group were most recently submitted for deletion.
• DeleteGroupName: string
  Title: Name

  Maximum Length: 80

  Name of the delete group.
• DeleteGroupSequenceId: integer (int64)
  Value that uniquely identifies the delete group.
• Description: string
  Title: Description

  Maximum Length: 240

  Description of the delete group.
• InstanceId: integer
  Value that uniquely identifies the delete request or import request instance that was used to the delete the entity.
• items: array Items
  Title: Items

  Name or number of the part, item, product, or service.Items can be added to a delete group for deletion.
• LastActivity: string
  Maximum Length: 100

  Value that identifies the last activity performed on the delete group.
• LastActivityName: string
  Maximum Length: 255

  Name of the last activity performed on the delete group. The possible values are Constraints Check and Delete Group Submission.
• LastActivityStatus: string
  Maximum Length: 20

  Value that identifies the status of the last activity performed on the delete group.
• LastActivityStatusName: string
  Maximum Length: 255

  Status of the last activity performed on the delete group. The possible values are Completed, Errors, In Progress, Open, and Ready for Deletion.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the delete group.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the delete group.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• newItemRequests: array New Item Requests
  Title: New Item Requests

  New item requests are created to define item information and its entities, including specifications, structures and packs, and relationships. In addition to being defined, the new item requests are also routed for approval.New item requests can be added to a delete group for deletion.
• ProcessStatus: string
  Maximum Length: 50

  Value that identifies the overall status of the delete group.
• ProcessStatusName: string
  Maximum Length: 255

  Status of the delete group. The possible values are Completed, Errors, In Progress, Open, and Ready for Deletion.
• structures: array Structures
  Title: Structures

  Structures are used to store lists of items that are associated with a parent item and information about how each item is related to its parent. Item structures can added to a delete group for deletion.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the delete group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the delete group.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DateLastSubmitted":{
            "title":"Last Submission Date",
            "type":"string",
            "description":"Date when the entities in the delete group were most recently submitted for deletion.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "DeleteGroupName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the delete group.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteGroupSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the delete group.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the delete group.",
            "nullable":true,
            "x-queryable":true
        },
        "InstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the delete request or import request instance that was used to the delete the entity.",
            "nullable":true,
            "x-queryable":true
        },
        "LastActivity":{
            "maxLength":100,
            "type":"string",
            "description":"Value that identifies the last activity performed on the delete group.",
            "nullable":true,
            "x-queryable":true
        },
        "LastActivityName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the last activity performed on the delete group. The possible values are Constraints Check and Delete Group Submission.",
            "nullable":true,
            "x-queryable":true
        },
        "LastActivityStatus":{
            "maxLength":20,
            "type":"string",
            "description":"Value that identifies the status of the last activity performed on the delete group.",
            "nullable":true,
            "x-queryable":true
        },
        "LastActivityStatusName":{
            "maxLength":255,
            "type":"string",
            "description":"Status of the last activity performed on the delete group. The possible values are Completed, Errors, In Progress, Open, and Ready for Deletion.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the delete group.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the delete group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the delete group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessStatus":{
            "maxLength":50,
            "type":"string",
            "description":"Value that identifies the overall status of the delete group.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessStatusName":{
            "maxLength":255,
            "type":"string",
            "description":"Status of the delete group. The possible values are Completed, Errors, In Progress, Open, and Ready for Deletion.",
            "nullable":true,
            "x-queryable":true
        },
        "changeOrders":{
            "title":"Change Orders",
            "type":"array",
            "description":"Change orders let you process changes to user-defined item attributes, structures, packs, associations, and item revisions. A change order can be added to a delete group for deletion.",
            "items":{
                "$ref":"#/components/schemas/deleteGroups-changeOrders-item-response"
            }
        },
        "components":{
            "title":"Components",
            "type":"array",
            "description":"Item structure components added to a delete group for deletion.",
            "items":{
                "$ref":"#/components/schemas/deleteGroups-components-item-response"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"Name or number of the part, item, product, or service.Items can be added to a delete group for deletion.",
            "items":{
                "$ref":"#/components/schemas/deleteGroups-items-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "newItemRequests":{
            "title":"New Item Requests",
            "type":"array",
            "description":"New item requests are created to define item information and its entities, including specifications, structures and packs, and relationships. In addition to being defined, the new item requests are also routed for approval.New item requests can be added to a delete group for deletion.",
            "items":{
                "$ref":"#/components/schemas/deleteGroups-newItemRequests-item-response"
            }
        },
        "structures":{
            "title":"Structures",
            "type":"array",
            "description":"Structures are used to store lists of items that are associated with a parent item and information about how each item is related to its parent. Item structures can added to a delete group for deletion.",
            "items":{
                "$ref":"#/components/schemas/deleteGroups-structures-item-response"
            }
        }
    }
}

Nested Schema : Change Orders

Type: array

Title: Change Orders

Change orders let you process changes to user-defined item attributes, structures, packs, associations, and item revisions. A change order can be added to a delete group for deletion.

Show Source

• Array of: object deleteGroups-changeOrders-item-response

{
    "title":"Change Orders",
    "type":"array",
    "description":"Change orders let you process changes to user-defined item attributes, structures, packs, associations, and item revisions. A change order can be added to a delete group for deletion.",
    "items":{
        "$ref":"#/components/schemas/deleteGroups-changeOrders-item-response"
    }
}

Nested Schema : Components

Type: array

Title: Components

Item structure components added to a delete group for deletion.

Show Source

• Array of: object deleteGroups-components-item-response

{
    "title":"Components",
    "type":"array",
    "description":"Item structure components added to a delete group for deletion.",
    "items":{
        "$ref":"#/components/schemas/deleteGroups-components-item-response"
    }
}

Nested Schema : Items

Type: array

Title: Items

Name or number of the part, item, product, or service.Items can be added to a delete group for deletion.

Show Source

• Array of: object deleteGroups-items-item-response

{
    "title":"Items",
    "type":"array",
    "description":"Name or number of the part, item, product, or service.Items can be added to a delete group for deletion.",
    "items":{
        "$ref":"#/components/schemas/deleteGroups-items-item-response"
    }
}

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 : New Item Requests

Type: array

Title: New Item Requests

New item requests are created to define item information and its entities, including specifications, structures and packs, and relationships. In addition to being defined, the new item requests are also routed for approval.New item requests can be added to a delete group for deletion.

Show Source

• Array of: object deleteGroups-newItemRequests-item-response

{
    "title":"New Item Requests",
    "type":"array",
    "description":"New item requests are created to define item information and its entities, including specifications, structures and packs, and relationships. In addition to being defined, the new item requests are also routed for approval.New item requests can be added to a delete group for deletion.",
    "items":{
        "$ref":"#/components/schemas/deleteGroups-newItemRequests-item-response"
    }
}

Nested Schema : Structures

Type: array

Title: Structures

Structures are used to store lists of items that are associated with a parent item and information about how each item is related to its parent. Item structures can added to a delete group for deletion.

Show Source

• Array of: object deleteGroups-structures-item-response

{
    "title":"Structures",
    "type":"array",
    "description":"Structures are used to store lists of items that are associated with a parent item and information about how each item is related to its parent. Item structures can added to a delete group for deletion.",
    "items":{
        "$ref":"#/components/schemas/deleteGroups-structures-item-response"
    }
}

Nested Schema : deleteGroups-changeOrders-item-response

Type: object

Show Source

• ChangeId: integer (int64)
  Value that uniquely identifies a change order.
• ChangeOrder: string
  Maximum Length: 255

  Name of the change order.
• ChangeOrderStatus: string
  Maximum Length: 255

  Status of the change order.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date when the user created the change order.
• DeleteEntitySequenceId: integer (int64)
  Value that uniquely identifies a change order in a delete group.
• DeleteGroupSequenceId: integer (int64)
  Value that uniquely identifies the delete group to which the change order belongs.
• DeleteStatusType: integer (int32)
  Title: Status

  Read Only: true

  Default Value: 1

  Value that uniquely identifies the deletion status of the change order.
• DeleteStatusTypeName: string
  Maximum Length: 255

  Deletion status of the change order.
• Description: string
  Maximum Length: 255

  Description of the change order.
• 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 change order.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the change order.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• Organization: string
  Maximum Length: 255

  Value that uniquely identifies the organization to which the change order belongs.

{
    "type":"object",
    "properties":{
        "ChangeId":{
            "type":"integer",
            "description":"Value that uniquely identifies a change order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChangeOrder":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the change order.",
            "nullable":true,
            "x-queryable":true
        },
        "ChangeOrderStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Status of the change order.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the change order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the change order.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteEntitySequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies a change order in a delete group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeleteGroupSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the delete group to which the change order belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeleteStatusType":{
            "title":"Status",
            "type":"integer",
            "description":"Value that uniquely identifies the deletion status of the change order.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "DeleteStatusTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Deletion status of the change order.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the change order.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the change order.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the change order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the change order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Organization":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the organization to which the change order belongs.",
            "nullable":true,
            "x-queryable":true
        },
        "errors":{
            "title":"Errors",
            "type":"array",
            "description":"Errors encountered during the deletion of a particular entity in a delete group.",
            "items":{
                "$ref":"#/components/schemas/deleteGroups-changeOrders-errors-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Errors

Type: array

Title: Errors

Errors encountered during the deletion of a particular entity in a delete group.

Show Source

• Array of: object deleteGroups-changeOrders-errors-item-response

{
    "title":"Errors",
    "type":"array",
    "description":"Errors encountered during the deletion of a particular entity in a delete group.",
    "items":{
        "$ref":"#/components/schemas/deleteGroups-changeOrders-errors-item-response"
    }
}

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 : deleteGroups-changeOrders-errors-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the delete group entity for which the error has been encountered.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the delete group entity for which the error has been encountered.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteEntitySequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the delete group entity for which the error has been encountered.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ErrorCode":{
            "title":"Code",
            "maxLength":100,
            "type":"string",
            "description":"Number of the error message encountered while deleting an entity in a delete group.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessage":{
            "title":"Message",
            "maxLength":4000,
            "type":"string",
            "description":"Error message encountered while deleting an entity in a delete group.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the delete group entity for which the error has been encountered.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the delete group entity for which the error has been encountered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the delete group entity for which the error has been encountered.",
            "nullable":false,
            "readOnly":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."
        }
    }
}

Nested Schema : deleteGroups-components-item-response

Type: object

Show Source

• 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.
• ItemNumber: number
  Attribute that represents the item number of a component.
• ItemObjectType: string
  Read Only: true

  Maximum Length: 400

  Value that identifies the item object type of a component.
• 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.
• OperationSequenceNumber: number
  Value that identifies the find number of the component.
• 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.

{
    "type":"object",
    "properties":{
        "BillSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the structure to which the component belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Component":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the component.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the component item.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies a component in a structure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the component.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteEntitySequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies a component in a delete group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeleteGroupSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the delete group to which the component belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeleteStatusType":{
            "title":"Status",
            "type":"integer",
            "description":"Value that uniquely identifies the deletion status of the component.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "DeleteStatusTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Deletion status of the component.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "type":"number",
            "description":"Attribute that represents the item number of a component.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemObjectType":{
            "maxLength":400,
            "type":"string",
            "description":"Value that identifies the item object type of a component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the component.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "type":"number",
            "description":"Value that identifies the find number of the component.",
            "nullable":true,
            "x-queryable":true
        },
        "Organization":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the organization to which the component belongs.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization to which the component belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentItem":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the item to which the component belongs.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentItemDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the item to which the component belongs.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item to which the component belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Structure":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the structure to which the component belongs.",
            "nullable":true,
            "x-queryable":true
        },
        "errors":{
            "title":"Errors",
            "type":"array",
            "description":"Errors encountered during the deletion of a particular entity in a delete group.",
            "items":{
                "$ref":"#/components/schemas/deleteGroups-components-errors-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Errors

Type: array

Title: Errors

Errors encountered during the deletion of a particular entity in a delete group.

Show Source

• Array of: object deleteGroups-components-errors-item-response

{
    "title":"Errors",
    "type":"array",
    "description":"Errors encountered during the deletion of a particular entity in a delete group.",
    "items":{
        "$ref":"#/components/schemas/deleteGroups-components-errors-item-response"
    }
}

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 : deleteGroups-components-errors-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the delete group entity for which the error has been encountered.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the delete group entity for which the error has been encountered.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteEntitySequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the delete group entity for which the error has been encountered.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ErrorCode":{
            "title":"Code",
            "maxLength":100,
            "type":"string",
            "description":"Number of the error message encountered while deleting an entity in a delete group.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessage":{
            "title":"Message",
            "maxLength":4000,
            "type":"string",
            "description":"Error message encountered while deleting an entity in a delete group.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the delete group entity for which the error has been encountered.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the delete group entity for which the error has been encountered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the delete group entity for which the error has been encountered.",
            "nullable":false,
            "readOnly":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 : deleteGroups-items-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date when the user created the item.
• DeleteEntitySequenceId: integer (int64)
  Value that uniquely identifies an item in a delete group.
• DeleteGroupSequenceId: integer (int64)
  Value that uniquely identifies the delete group to which the item belongs.
• DeleteStatusType: integer (int32)
  Title: Status

  Read Only: true

  Default Value: 1

  Value that uniquely identifies the deletion status of the item.
• DeleteStatusTypeName: string
  Maximum Length: 255

  Deletion status of the item.
• Description: string
  Maximum Length: 255

  Description of the item.
• errors: array Errors
  Title: Errors

  Errors encountered during the deletion of a particular entity in a delete group.
• InventoryItemId: integer (int64)
  Value that uniquely identifies an item.
• Item: string
  Maximum Length: 255

  Name or number of the part, item, product, or service.
• ItemObjectType: string
  Read Only: true

  Maximum Length: 400

  Value that identifies the object type of an item.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the item.
• 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.
• Organization: string
  Maximum Length: 255

  Abbreviation that identifies the organization to which the item belongs.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization to which the item belongs.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the item.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteEntitySequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies an item in a delete group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeleteGroupSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the delete group to which the item belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeleteStatusType":{
            "title":"Status",
            "type":"integer",
            "description":"Value that uniquely identifies the deletion status of the item.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "DeleteStatusTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Deletion status of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies an item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Item":{
            "maxLength":255,
            "type":"string",
            "description":"Name or number of the part, item, product, or service.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemObjectType":{
            "maxLength":400,
            "type":"string",
            "description":"Value that identifies the object type of an item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the item.",
            "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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Organization":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the organization to which the item belongs.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization to which the item belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "errors":{
            "title":"Errors",
            "type":"array",
            "description":"Errors encountered during the deletion of a particular entity in a delete group.",
            "items":{
                "$ref":"#/components/schemas/deleteGroups-items-errors-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Errors

Type: array

Title: Errors

Errors encountered during the deletion of a particular entity in a delete group.

Show Source

• Array of: object deleteGroups-items-errors-item-response

{
    "title":"Errors",
    "type":"array",
    "description":"Errors encountered during the deletion of a particular entity in a delete group.",
    "items":{
        "$ref":"#/components/schemas/deleteGroups-items-errors-item-response"
    }
}

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 : deleteGroups-items-errors-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the delete group entity for which the error has been encountered.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the delete group entity for which the error has been encountered.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteEntitySequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the delete group entity for which the error has been encountered.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ErrorCode":{
            "title":"Code",
            "maxLength":100,
            "type":"string",
            "description":"Number of the error message encountered while deleting an entity in a delete group.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessage":{
            "title":"Message",
            "maxLength":4000,
            "type":"string",
            "description":"Error message encountered while deleting an entity in a delete group.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the delete group entity for which the error has been encountered.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the delete group entity for which the error has been encountered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the delete group entity for which the error has been encountered.",
            "nullable":false,
            "readOnly":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 : deleteGroups-newItemRequests-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date when the user created the new item request.
• DeleteEntitySequenceId: integer (int64)
  Value that uniquely identifies the new item request in a delete group.
• DeleteGroupSequenceId: integer (int64)
  Value that uniquely identifies the delete group to which the new item request belongs.
• DeleteStatusType: integer (int32)
  Title: Status

  Read Only: true

  Default Value: 1

  Value that uniquely identifies the deletion status of the new item request.
• DeleteStatusTypeName: string
  Maximum Length: 255

  Deletion status of the new item request.
• Description: string
  Maximum Length: 255

  Description of the new item request.
• 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 new item request.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the new item request.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• NewItemRequest: string
  Maximum Length: 255

  Name of the new item request.
• NewItemRequestId: integer (int64)
  Value that uniquely identifies a new item request.
• NewItemRequestStatus: string
  Maximum Length: 255

  Status of the new item request.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the new item request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the new item request.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteEntitySequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the new item request in a delete group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeleteGroupSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the delete group to which the new item request belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeleteStatusType":{
            "title":"Status",
            "type":"integer",
            "description":"Value that uniquely identifies the deletion status of the new item request.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "DeleteStatusTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Deletion status of the new item request.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the new item request.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the new item request.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the new item request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the new item request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NewItemRequest":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the new item request.",
            "nullable":true,
            "x-queryable":true
        },
        "NewItemRequestId":{
            "type":"integer",
            "description":"Value that uniquely identifies a new item request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NewItemRequestStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Status of the new item request.",
            "nullable":true,
            "x-queryable":true
        },
        "errors":{
            "title":"Errors",
            "type":"array",
            "description":"Errors encountered during the deletion of a particular entity in a delete group.",
            "items":{
                "$ref":"#/components/schemas/deleteGroups-newItemRequests-errors-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Errors

Type: array

Title: Errors

Errors encountered during the deletion of a particular entity in a delete group.

Show Source

• Array of: object deleteGroups-newItemRequests-errors-item-response

{
    "title":"Errors",
    "type":"array",
    "description":"Errors encountered during the deletion of a particular entity in a delete group.",
    "items":{
        "$ref":"#/components/schemas/deleteGroups-newItemRequests-errors-item-response"
    }
}

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 : deleteGroups-newItemRequests-errors-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the delete group entity for which the error has been encountered.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the delete group entity for which the error has been encountered.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteEntitySequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the delete group entity for which the error has been encountered.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ErrorCode":{
            "title":"Code",
            "maxLength":100,
            "type":"string",
            "description":"Number of the error message encountered while deleting an entity in a delete group.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessage":{
            "title":"Message",
            "maxLength":4000,
            "type":"string",
            "description":"Error message encountered while deleting an entity in a delete group.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the delete group entity for which the error has been encountered.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the delete group entity for which the error has been encountered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the delete group entity for which the error has been encountered.",
            "nullable":false,
            "readOnly":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 : deleteGroups-structures-item-response

Type: object

Show Source

• BillSequenceId: integer (int64)
  Value that uniquely identifies a structure.
• Component: string
  Maximum Length: 255

  Value that identifies the structure component that must be deleted.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date when the user created the structure.
• DeleteEntitySequenceId: integer (int64)
  Value that uniquely identifies the structure in a delete group.
• DeleteGroupSequenceId: integer (int64)
  Value that uniquely identifies the delete group to which the structure belongs.
• DeleteStatusType: integer (int32)
  Title: Status

  Read Only: true

  Default Value: 1

  Value that uniquely identifies the deletion status of the structure.
• DeleteStatusTypeName: string
  Maximum Length: 255

  Deletion status of the structure.
• Description: string
  Maximum Length: 255

  Description of the structure.
• errors: array Errors
  Title: Errors

  Errors encountered during the deletion of a particular entity in a delete group.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the item to which the structure belongs.
• Item: string
  Maximum Length: 255

  Name or number of the part, item, product, or service to which the structure belongs.
• ItemObjectType: string
  Read Only: true

  Maximum Length: 400

  Value that identifies the item object type of the item structure.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the structure.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Maximum Length: 32

  Login that the user used when updating the structure.
• 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 structure belongs.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization to which the structure belongs.
• Structure: string
  Maximum Length: 255

  Name of the structure.

{
    "type":"object",
    "properties":{
        "BillSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies a structure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Component":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the structure component that must be deleted.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the structure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the structure.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteEntitySequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the structure in a delete group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeleteGroupSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the delete group to which the structure belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeleteStatusType":{
            "title":"Status",
            "type":"integer",
            "description":"Value that uniquely identifies the deletion status of the structure.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "DeleteStatusTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Deletion status of the structure.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the structure.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item to which the structure belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Item":{
            "maxLength":255,
            "type":"string",
            "description":"Name or number of the part, item, product, or service to which the structure belongs.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemObjectType":{
            "maxLength":400,
            "type":"string",
            "description":"Value that identifies the item object type of the item structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the structure.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the structure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the structure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Organization":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the organization to which the structure belongs.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization to which the structure belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Structure":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the structure.",
            "nullable":true,
            "x-queryable":true
        },
        "errors":{
            "title":"Errors",
            "type":"array",
            "description":"Errors encountered during the deletion of a particular entity in a delete group.",
            "items":{
                "$ref":"#/components/schemas/deleteGroups-structures-errors-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Errors

Type: array

Title: Errors

Errors encountered during the deletion of a particular entity in a delete group.

Show Source

• Array of: object deleteGroups-structures-errors-item-response

{
    "title":"Errors",
    "type":"array",
    "description":"Errors encountered during the deletion of a particular entity in a delete group.",
    "items":{
        "$ref":"#/components/schemas/deleteGroups-structures-errors-item-response"
    }
}

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 : deleteGroups-structures-errors-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the delete group entity for which the error has been encountered.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the delete group entity for which the error has been encountered.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteEntitySequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the delete group entity for which the error has been encountered.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ErrorCode":{
            "title":"Code",
            "maxLength":100,
            "type":"string",
            "description":"Number of the error message encountered while deleting an entity in a delete group.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessage":{
            "title":"Message",
            "maxLength":4000,
            "type":"string",
            "description":"Error message encountered while deleting an entity in a delete group.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the delete group entity for which the error has been encountered.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the delete group entity for which the error has been encountered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the delete group entity for which the error has been encountered.",
            "nullable":false,
            "readOnly":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"
    }
}

Links

changeOrders

Operation: /fscmRestApi/resources/11.13.18.05/deleteGroups/{DeleteGroupSequenceId}/child/changeOrders

Parameters:

• DeleteGroupSequenceId: $request.path.DeleteGroupSequenceId

Change orders let you process changes to user-defined item attributes, structures, packs, associations, and item revisions. A change order can be added to a delete group for deletion.

components

Operation: /fscmRestApi/resources/11.13.18.05/deleteGroups/{DeleteGroupSequenceId}/child/components

Parameters:

• DeleteGroupSequenceId: $request.path.DeleteGroupSequenceId

Item structure components added to a delete group for deletion.

items

Operation: /fscmRestApi/resources/11.13.18.05/deleteGroups/{DeleteGroupSequenceId}/child/items

Parameters:

• DeleteGroupSequenceId: $request.path.DeleteGroupSequenceId

Name or number of the part, item, product, or service.Items can be added to a delete group for deletion.

newItemRequests

Operation: /fscmRestApi/resources/11.13.18.05/deleteGroups/{DeleteGroupSequenceId}/child/newItemRequests

Parameters:

• DeleteGroupSequenceId: $request.path.DeleteGroupSequenceId

New item requests are created to define item information and its entities, including specifications, structures and packs, and relationships. In addition to being defined, the new item requests are also routed for approval.New item requests can be added to a delete group for deletion.

structures

Operation: /fscmRestApi/resources/11.13.18.05/deleteGroups/{DeleteGroupSequenceId}/child/structures

Parameters:

• DeleteGroupSequenceId: $request.path.DeleteGroupSequenceId

Structures are used to store lists of items that are associated with a parent item and information about how each item is related to its parent. Item structures can added to a delete group for deletion.

Back to Top