Jump to

• Request
• Response

Get one new item request

get

/fscmRestApi/resources/11.13.18.05/deleteGroups/{DeleteGroupSequenceId}/child/newItemRequests/{DeleteEntitySequenceId}

Request

Path Parameters

• DeleteEntitySequenceId(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=
• 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-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":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated 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
        },
        "NewItemRequest":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the new item request.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the new item request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the new item request.",
            "nullable":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
        },
        "NewItemRequestStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Status 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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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"
            }
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the new item request.",
            "nullable":true,
            "readOnly":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
        },
        "DeleteStatusTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Deletion status of the new item request.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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":{
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "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
        },
        "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
        }
    }
}

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/newItemRequests/{DeleteEntitySequenceId}/child/errors

Parameters:

• DeleteEntitySequenceId4: $request.path.DeleteEntitySequenceId4
• DeleteGroupSequenceId: $request.path.DeleteGroupSequenceId

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

Back to Top