Jump to

• Request
• Response

Add an item structure

post

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

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: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

  Value that identifies the structure component that must be deleted.
• DeleteEntitySequenceId: integer (int64)
  Value that uniquely identifies the structure in a delete group.
• DeleteGroupSequenceId(required): integer (int64)
  Value that uniquely identifies the delete group to which the structure belongs.
• 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.
• 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.

{
    "required":[
        "DeleteGroupSequenceId"
    ],
    "type":"object",
    "properties":{
        "BillSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies a structure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Component":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the structure component that must be deleted.",
            "nullable":true
        },
        "DeleteEntitySequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the structure in a delete group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DeleteGroupSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the delete group to which the structure belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DeleteStatusTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Deletion status of the structure.",
            "nullable":true
        },
        "Description":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the structure.",
            "nullable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item to which the structure belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Item":{
            "maxLength":255,
            "type":"string",
            "description":"Name or number of the part, item, product, or service to which the structure belongs.",
            "nullable":true
        },
        "Organization":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the organization to which the structure belongs.",
            "nullable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization to which the structure belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Structure":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the structure.",
            "nullable":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-post-request"
            }
        }
    }
}

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-post-request

{
    "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-post-request"
    }
}

Nested Schema : deleteGroups-structures-errors-item-post-request

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "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
            }
        },
        "ErrorCode":{
            "title":"Code",
            "maxLength":100,
            "type":"string",
            "description":"Number of the error message encountered while deleting an entity in a delete group.",
            "nullable":true
        },
        "ErrorMessage":{
            "title":"Message",
            "maxLength":4000,
            "type":"string",
            "description":"Error message encountered while deleting an entity in a delete group.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : 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"
    }
}

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."
        }
    }
}

Links

errors

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

Parameters:

• DeleteEntitySequenceId5: $request.path.DeleteEntitySequenceId5
• DeleteGroupSequenceId: $request.path.DeleteGroupSequenceId

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

Back to Top