Jump to

• Request
• Response

Update one line type

patch

/fscmRestApi/resources/11.13.18.05/purchasingLineTypes/{LineTypeId}

Request

Path Parameters

• LineTypeId(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

• DefaultCategoryId: integer (int64)
  Title: Default Category ID

  Value that uniquely identifies the default category.
• DefaultInvoiceMatchOption: string
  Title: Default Invoice Match Option

  Maximum Length: 80

  Name of the default invoice match option.
• DefaultInvoiceMatchOptionCode: string
  Title: Default Invoice Match Option Code

  Maximum Length: 25

  Abbreviation that identifies the default invoice match option.
• DefaultMatchApprovalLevelCode: string
  Title: Default Match Approval Level Code

  Maximum Length: 255

  Abbreviation that identifies the match approval level.
• DefaultReceiptCloseTolerancePercent: number
  Title: Default Receipt Close Tolerance Percent

  Default value for the permissible variance between the anticipated amount of goods or services and the actual amount delivered.
• DefaultUOMCode: string
  Title: Default UOM Code

  Maximum Length: 3

  Abbreviation that identifies the default unit of measure.
• DFF: array DFF
• EndDate: string (date)
  Title: End Date

  Date after which the line type is no longer valid.
• LineType: string
  Title: Line Type

  Maximum Length: 30

  Name that uniquely identifies the purchasing line type.
• LineTypeDescription: string
  Title: Description

  Maximum Length: 240

  Description of the purchasing line type.
• ProductType: string
  Title: Product Type

  Maximum Length: 80

  Name of the product type.
• ProductTypeCode: string
  Title: Product Type Code

  Maximum Length: 30

  Default Value: GOODS

  Abbreviation that identifies the product type.

{
    "type":"object",
    "properties":{
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/purchasingLineTypes-DFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "DefaultCategoryId":{
            "title":"Default Category ID",
            "type":"integer",
            "description":"Value that uniquely identifies the default category.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DefaultInvoiceMatchOption":{
            "title":"Default Invoice Match Option",
            "maxLength":80,
            "type":"string",
            "description":"Name of the default invoice match option.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        },
        "DefaultInvoiceMatchOptionCode":{
            "title":"Default Invoice Match Option Code",
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the default invoice match option.",
            "nullable":true,
            "x-queryable":false
        },
        "DefaultMatchApprovalLevelCode":{
            "title":"Default Match Approval Level Code",
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the match approval level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DefaultReceiptCloseTolerancePercent":{
            "title":"Default Receipt Close Tolerance Percent",
            "type":"number",
            "description":"Default value for the permissible variance between the anticipated amount of goods or services and the actual amount delivered.",
            "nullable":true,
            "x-queryable":false
        },
        "DefaultUOMCode":{
            "title":"Default UOM Code",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the default unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date after which the line type is no longer valid.",
            "format":"date",
            "nullable":true
        },
        "LineType":{
            "title":"Line Type",
            "maxLength":30,
            "type":"string",
            "description":"Name that uniquely identifies the purchasing line type.",
            "nullable":false
        },
        "LineTypeDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the purchasing line type.",
            "nullable":false
        },
        "ProductType":{
            "title":"Product Type",
            "maxLength":80,
            "type":"string",
            "description":"Name of the product type.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        },
        "ProductTypeCode":{
            "title":"Product Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the product type.",
            "nullable":false,
            "default":"GOODS",
            "x-queryable":false
        }
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/purchasingLineTypes-DFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Prompt

  Maximum Length: 30

  Context Prompt
• __FLEX_Context_DisplayValue: string
  Title: Context Prompt

  Context Prompt

{
    "type":"object",
    "properties":{
        "__FLEX_Context":{
            "title":"Context Prompt",
            "maxLength":30,
            "type":"string",
            "description":"Context Prompt",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Prompt",
            "type":"string",
            "description":"Context Prompt",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the purchasing line type was created.
• CreditLineFlag: boolean
  Title: Credit Line

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, the credit line type is enabled for this line type. If false, the credit line type isn't enabled for this line type.
• DefaultCategory: string
  Title: Default Category

  Read Only: true

  Maximum Length: 2400

  Name of the default category.
• DefaultCategoryId: integer (int64)
  Title: Default Category ID

  Value that uniquely identifies the default category.
• DefaultInvoiceMatchOption: string
  Title: Default Invoice Match Option

  Maximum Length: 80

  Name of the default invoice match option.
• DefaultInvoiceMatchOptionCode: string
  Title: Default Invoice Match Option Code

  Maximum Length: 25

  Abbreviation that identifies the default invoice match option.
• DefaultMatchApprovalLevel: string
  Title: Default Match Approval Level

  Read Only: true

  Maximum Length: 255

  Name of the default match approval level.
• DefaultMatchApprovalLevelCode: string
  Title: Default Match Approval Level Code

  Maximum Length: 255

  Abbreviation that identifies the match approval level.
• DefaultReceiptCloseTolerancePercent: number
  Title: Default Receipt Close Tolerance Percent

  Default value for the permissible variance between the anticipated amount of goods or services and the actual amount delivered.
• DefaultUOM: string
  Title: Default UOM

  Read Only: true

  Maximum Length: 25

  Name of the default unit of measure.
• DefaultUOMCode: string
  Title: Default UOM Code

  Maximum Length: 3

  Abbreviation that identifies the default unit of measure.
• DFF: array DFF
• EndDate: string (date)
  Title: End Date

  Date after which the line type is no longer valid.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the line type.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the line type.
• LineType: string
  Title: Line Type

  Maximum Length: 30

  Name that uniquely identifies the purchasing line type.
• LineTypeCode: string
  Title: Line Type Code

  Maximum Length: 30

  Abbreviation that identifies the purchasing line type.
• LineTypeDescription: string
  Title: Description

  Maximum Length: 240

  Description of the purchasing line type.
• LineTypeId: integer (int64)
  Title: Line Type ID

  Read Only: true

  Value that uniquely identifies the purchasing line type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProductType: string
  Title: Product Type

  Maximum Length: 80

  Name of the product type.
• ProductTypeCode: string
  Title: Product Type Code

  Maximum Length: 30

  Default Value: GOODS

  Abbreviation that identifies the product type.
• PurchaseBasis: string
  Title: Purchase Basis

  Maximum Length: 80

  Name of the purchase basis lookup type.
• PurchaseBasisCode: string
  Title: Purchase Basis Code

  Maximum Length: 30

  Default Value: GOODS

  Abbreviation that identifies the purchase basis lookup type.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the line type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the purchasing line type was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreditLineFlag":{
            "title":"Credit Line",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the credit line type is enabled for this line type. If false, the credit line type isn't enabled for this line type.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/purchasingLineTypes-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "DefaultCategory":{
            "title":"Default Category",
            "maxLength":2400,
            "type":"string",
            "description":"Name of the default category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DefaultCategoryId":{
            "title":"Default Category ID",
            "type":"integer",
            "description":"Value that uniquely identifies the default category.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DefaultInvoiceMatchOption":{
            "title":"Default Invoice Match Option",
            "maxLength":80,
            "type":"string",
            "description":"Name of the default invoice match option.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        },
        "DefaultInvoiceMatchOptionCode":{
            "title":"Default Invoice Match Option Code",
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the default invoice match option.",
            "nullable":true,
            "x-queryable":false
        },
        "DefaultMatchApprovalLevel":{
            "title":"Default Match Approval Level",
            "maxLength":255,
            "type":"string",
            "description":"Name of the default match approval level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DefaultMatchApprovalLevelCode":{
            "title":"Default Match Approval Level Code",
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the match approval level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DefaultReceiptCloseTolerancePercent":{
            "title":"Default Receipt Close Tolerance Percent",
            "type":"number",
            "description":"Default value for the permissible variance between the anticipated amount of goods or services and the actual amount delivered.",
            "nullable":true,
            "x-queryable":false
        },
        "DefaultUOM":{
            "title":"Default UOM",
            "maxLength":25,
            "type":"string",
            "description":"Name of the default unit of measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"edit",
                "sortable":false
            }
        },
        "DefaultUOMCode":{
            "title":"Default UOM Code",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the default unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date after which the line type is no longer valid.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the line type.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the line type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LineType":{
            "title":"Line Type",
            "maxLength":30,
            "type":"string",
            "description":"Name that uniquely identifies the purchasing line type.",
            "nullable":false,
            "x-queryable":true
        },
        "LineTypeCode":{
            "title":"Line Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the purchasing line type.",
            "nullable":false,
            "x-queryable":true
        },
        "LineTypeDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the purchasing line type.",
            "nullable":false,
            "x-queryable":true
        },
        "LineTypeId":{
            "title":"Line Type ID",
            "type":"integer",
            "description":"Value that uniquely identifies the purchasing line type.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductType":{
            "title":"Product Type",
            "maxLength":80,
            "type":"string",
            "description":"Name of the product type.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        },
        "ProductTypeCode":{
            "title":"Product Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the product type.",
            "nullable":false,
            "default":"GOODS",
            "x-queryable":false
        },
        "PurchaseBasis":{
            "title":"Purchase Basis",
            "maxLength":80,
            "type":"string",
            "description":"Name of the purchase basis lookup type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            },
            "x-queryable":true
        },
        "PurchaseBasisCode":{
            "title":"Purchase Basis Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the purchase basis lookup type.",
            "nullable":false,
            "default":"GOODS",
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object purchasingLineTypes-DFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/purchasingLineTypes-DFF-item-response"
    },
    "x-cardinality":"1"
}

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 : purchasingLineTypes-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Prompt

  Maximum Length: 30

  Context Prompt
• __FLEX_Context_DisplayValue: string
  Title: Context Prompt

  Context Prompt
• LineTypeId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LineTypeId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Prompt",
            "maxLength":30,
            "type":"string",
            "description":"Context Prompt",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Prompt",
            "type":"string",
            "description":"Context Prompt",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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

DFF

Operation: /fscmRestApi/resources/11.13.18.05/purchasingLineTypes/{LineTypeId}/child/DFF

Parameters:

• LineTypeId: $request.path.LineTypeId

Back to Top