Jump to

• Request
• Response

Get one special handling type

get

/fscmRestApi/resources/11.13.18.05/specialHandlingTypes/{specialHandlingTypesUniqID}

Request

Path Parameters

• specialHandlingTypesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Special Handling Types resource and used to uniquely identify an instance of Special Handling Types. The client should not generate the hash key value. Instead, the client should query on the Special Handling Types collection resource in order to navigate to a specific instance of Special Handling Types to get the hash key.

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

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

Type: object

Show Source

• AutomaticallyCreateReceiptFlag: boolean
  Title: Automatically Create Receipt

  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then a receipt will be created automatically after the purchase order is implemented. If false, then the application won't create a receipt.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the special handling type.
• EnabledFlag: boolean
  Title: Enabled

  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, the special handling type will be available for document creation. If false, you won't be able to create documents with that type.
• HeaderContext: string
  Title: Header Context

  Read Only: true

  Maximum Length: 80

  Descriptive flexfield context display value for the special handling document header.
• HeaderContextCode: string
  Read Only: true

  Maximum Length: 30

  Descriptive flexfield context name for the special handling document header.
• LineContext: string
  Title: Line Context

  Read Only: true

  Maximum Length: 80

  Descriptive flexfield context display value for the special handling document line.
• LineContextCode: string
  Read Only: true

  Maximum Length: 30

  Descriptive flexfield context name for the special handling document line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NegotiatedFlag: boolean
  Title: Negotiated

  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, when creating special handling documents, the Negotiated field on the line will be enabled. If false, the Negotiated field won't be set by the application.
• RequiresBuyerReviewFlag: boolean
  Title: Requires Buyer Review

  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, special handling orders created from requisitions will require buyer review before submission. If false, special handling orders created from requisitions will be submitted automatically.
• SpecialHandlingType: string
  Title: Special Handling Type

  Read Only: true

  Maximum Length: 30

  Type that indicates that the document needs to be processed differently.
• SpecialHandlingTypeCode: string
  Title: Special Handling Type Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the special handling type.

{
    "type":"object",
    "properties":{
        "SpecialHandlingTypeCode":{
            "title":"Special Handling Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the special handling type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutomaticallyCreateReceiptFlag":{
            "title":"Automatically Create Receipt",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then a receipt will be created automatically after the purchase order is implemented. If false, then the application won't create a receipt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SpecialHandlingType":{
            "title":"Special Handling Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type that indicates that the document needs to be processed differently.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the special handling type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NegotiatedFlag":{
            "title":"Negotiated",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, when creating special handling documents, the Negotiated field on the line will be enabled. If false, the Negotiated field won't be set by the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LineContextCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for the special handling document line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "HeaderContextCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for the special handling document header.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LineContext":{
            "title":"Line Context",
            "maxLength":"80",
            "type":"string",
            "description":"Descriptive flexfield context display value for the special handling document line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the special handling type will be available for document creation. If false, you won't be able to create documents with that type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HeaderContext":{
            "title":"Header Context",
            "maxLength":"80",
            "type":"string",
            "description":"Descriptive flexfield context display value for the special handling document header.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RequiresBuyerReviewFlag":{
            "title":"Requires Buyer Review",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, special handling orders created from requisitions will require buyer review before submission. If false, special handling orders created from requisitions will be submitted automatically.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

Back to Top