Jump to

• Request
• Response
• Examples

Update one document style

patch

/fscmRestApi/resources/11.13.18.05/purchasingDocumentStyles/{purchasingDocumentStylesUniqID}

Request

Path Parameters

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

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

• AmountPurchaseBasisEnabledFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the amount purchase basis is enabled for this document style. If false, it isn't enabled.
• BlanketDocumentStyleTypeDisplayName: string
  Maximum Length: 240

  Display name of the blanket purchase agreement.
• BlanketDocumentStyleTypeEnabledFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the blanket purchase agreement is enabled for this document style. If false, it isn't enabled.
• ConfigurationOrderingEnabledFlag: boolean
  Title: Configuration Ordering Enabled

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, configuration ordering is enabled for this document style. If false, it isn't enabled.
• ConsignmentTermsEnabledFlag: boolean
  Title: Consignment Terms Enabled

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, consignment terms are enabled for this document style. If false, they aren't enabled.
• ContractDocumentStyleTypeDisplayName: string
  Maximum Length: 240

  Display name of the contract purchase agreement.
• ContractDocumentStyleTypeEnabledFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the contract purchase agreement is enabled for this document style. If false, it isn't enabled.
• CreditLineTypesEnabledFlag: boolean
  Title: Credit Line Types Enabled

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, the credit line types are enabled for this document style. If false, they aren't enabled.
• LineTypeAllowed: string
  Title: Line Types

  Maximum Length: 80

  Indicates whether the line type covers all or needs to be specified. Valid values: All, Specified.
• LineTypeAllowedCode: string
  Maximum Length: 30

  Abbreviation that identifies the allowed line types.
• lineTypes: array Line Types
  Title: Line Types

  Details of line types
• OutsideProcessingEnabledFlag: boolean
  Title: Outside Processing Enabled

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, outside processing is enabled for this document style. If false, it isn't enabled.
• PriceBreaksEnabledFlag: boolean
  Title: Price Breaks Allowed

  Maximum Length: 1

  Contains one of the following values: true or false. If true, price breaks are enabled for this document style. If false, they aren't enabled.
• ProgressPaymentEnabledFlag: boolean
  Title: Progress Payments Enabled

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, progress payments are enabled for this document style. If false, they aren't enabled.
• QuantityPurchaseBasisEnabledFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the quantity purchase basis is enabled for this document style. If false, it isn't enabled.
• RetainageEnabledFlag: boolean
  Title: Retainage Enabled

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, retainage is enabled for this document style. If false, it isn't enabled.
• StandardDocumentStyleTypeDisplayName: string
  Maximum Length: 240

  Display name of the purchase order.
• Status: string
  Title: Status

  Maximum Length: 80

  Status of the purchasing document style.
• StatusCode: string
  Maximum Length: 30

  Abbreviation that identifies the purchasing document style status.
• StyleDescription: string
  Title: Description

  Maximum Length: 240

  Description of the purchasing document style.
• StyleName: string
  Title: Style

  Maximum Length: 240

  Name that uniquely identifies the purchasing document style.
• WorkConfirmationEnabledFlag: boolean
  Title: Work Confirmation Enabled

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, work confirmation is enabled for this document style. If false, it isn't enabled.

{
    "type":"object",
    "properties":{
        "AmountPurchaseBasisEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the amount purchase basis is enabled for this document style. If false, it isn't enabled.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "BlanketDocumentStyleTypeDisplayName":{
            "maxLength":240,
            "type":"string",
            "description":"Display name of the blanket purchase agreement.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "BlanketDocumentStyleTypeEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the blanket purchase agreement is enabled for this document style. If false, it isn't enabled.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ConfigurationOrderingEnabledFlag":{
            "title":"Configuration Ordering Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, configuration ordering is enabled for this document style. If false, it isn't enabled.",
            "nullable":false,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ConsignmentTermsEnabledFlag":{
            "title":"Consignment Terms Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, consignment terms are enabled for this document style. If false, they aren't enabled.",
            "nullable":false,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ContractDocumentStyleTypeDisplayName":{
            "maxLength":240,
            "type":"string",
            "description":"Display name of the contract purchase agreement.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ContractDocumentStyleTypeEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the contract purchase agreement is enabled for this document style. If false, it isn't enabled.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreditLineTypesEnabledFlag":{
            "title":"Credit Line Types Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the credit line types are enabled for this document style. If false, they aren't enabled.",
            "nullable":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LineTypeAllowed":{
            "title":"Line Types",
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the line type covers all or needs to be specified. Valid values: All, Specified.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        },
        "LineTypeAllowedCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the allowed line types.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OutsideProcessingEnabledFlag":{
            "title":"Outside Processing Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, outside processing is enabled for this document style. If false, it isn't enabled.",
            "nullable":false,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PriceBreaksEnabledFlag":{
            "title":"Price Breaks Allowed",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, price breaks are enabled for this document style. If false, they aren't enabled.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ProgressPaymentEnabledFlag":{
            "title":"Progress Payments Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, progress payments are enabled for this document style. If false, they aren't enabled.",
            "nullable":false,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "QuantityPurchaseBasisEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the quantity purchase basis is enabled for this document style. If false, it isn't enabled.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RetainageEnabledFlag":{
            "title":"Retainage Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, retainage is enabled for this document style. If false, it isn't enabled.",
            "nullable":false,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "StandardDocumentStyleTypeDisplayName":{
            "maxLength":240,
            "type":"string",
            "description":"Display name of the purchase order.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Status":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"Status of the purchasing document style.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the purchasing document style status.",
            "nullable":false
        },
        "StyleDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the purchasing document style.",
            "nullable":true
        },
        "StyleName":{
            "title":"Style",
            "maxLength":240,
            "type":"string",
            "description":"Name that uniquely identifies the purchasing document style.",
            "nullable":false
        },
        "WorkConfirmationEnabledFlag":{
            "title":"Work Confirmation Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, work confirmation is enabled for this document style. If false, it isn't enabled.",
            "nullable":false,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "lineTypes":{
            "title":"Line Types",
            "type":"array",
            "description":"Details of line types",
            "items":{
                "$ref":"#/components/schemas/purchasingDocumentStyles-lineTypes-item-patch-request"
            }
        }
    }
}

Nested Schema : Line Types

Type: array

Title: Line Types

Details of line types

Show Source

• Array of: object purchasingDocumentStyles-lineTypes-item-patch-request

{
    "title":"Line Types",
    "type":"array",
    "description":"Details of line types",
    "items":{
        "$ref":"#/components/schemas/purchasingDocumentStyles-lineTypes-item-patch-request"
    }
}

Nested Schema : purchasingDocumentStyles-lineTypes-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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

Type: object

Show Source

• AmountPurchaseBasisEnabledFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the amount purchase basis is enabled for this document style. If false, it isn't enabled.
• BlanketDocumentStyleTypeDisplayName: string
  Maximum Length: 240

  Display name of the blanket purchase agreement.
• BlanketDocumentStyleTypeEnabledFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the blanket purchase agreement is enabled for this document style. If false, it isn't enabled.
• ConfigurationOrderingEnabledFlag: boolean
  Title: Configuration Ordering Enabled

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, configuration ordering is enabled for this document style. If false, it isn't enabled.
• ConsignmentTermsEnabledFlag: boolean
  Title: Consignment Terms Enabled

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, consignment terms are enabled for this document style. If false, they aren't enabled.
• ContractDocumentStyleTypeDisplayName: string
  Maximum Length: 240

  Display name of the contract purchase agreement.
• ContractDocumentStyleTypeEnabledFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the contract purchase agreement is enabled for this document style. If false, it isn't enabled.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the document style was created.
• CreditLineTypesEnabledFlag: boolean
  Title: Credit Line Types Enabled

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, the credit line types are enabled for this document style. If false, they aren't enabled.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the document style was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the document style.
• LineTypeAllowed: string
  Title: Line Types

  Maximum Length: 80

  Indicates whether the line type covers all or needs to be specified. Valid values: All, Specified.
• LineTypeAllowedCode: string
  Maximum Length: 30

  Abbreviation that identifies the allowed line types.
• lineTypes: array Line Types
  Title: Line Types

  Details of line types
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OutsideProcessingEnabledFlag: boolean
  Title: Outside Processing Enabled

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, outside processing is enabled for this document style. If false, it isn't enabled.
• PriceBreaksEnabledFlag: boolean
  Title: Price Breaks Allowed

  Maximum Length: 1

  Contains one of the following values: true or false. If true, price breaks are enabled for this document style. If false, they aren't enabled.
• ProgressPaymentEnabledFlag: boolean
  Title: Progress Payments Enabled

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, progress payments are enabled for this document style. If false, they aren't enabled.
• QuantityPurchaseBasisEnabledFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the quantity purchase basis is enabled for this document style. If false, it isn't enabled.
• RetainageEnabledFlag: boolean
  Title: Retainage Enabled

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, retainage is enabled for this document style. If false, it isn't enabled.
• StandardDocumentStyleTypeDisplayName: string
  Maximum Length: 240

  Display name of the purchase order.
• Status: string
  Title: Status

  Maximum Length: 80

  Status of the purchasing document style.
• StatusCode: string
  Maximum Length: 30

  Abbreviation that identifies the purchasing document style status.
• StyleDescription: string
  Title: Description

  Maximum Length: 240

  Description of the purchasing document style.
• StyleId: integer (int64)
  The unique identifier of the purchasing document style.
• StyleName: string
  Title: Style

  Maximum Length: 240

  Name that uniquely identifies the purchasing document style.
• StyleType: string
  Read Only: true

  Maximum Length: 30

  Style or format of the purchasing document.
• WorkConfirmationEnabledFlag: boolean
  Title: Work Confirmation Enabled

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, work confirmation is enabled for this document style. If false, it isn't enabled.

{
    "type":"object",
    "properties":{
        "AmountPurchaseBasisEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the amount purchase basis is enabled for this document style. If false, it isn't enabled.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "BlanketDocumentStyleTypeDisplayName":{
            "maxLength":240,
            "type":"string",
            "description":"Display name of the blanket purchase agreement.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "BlanketDocumentStyleTypeEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the blanket purchase agreement is enabled for this document style. If false, it isn't enabled.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ConfigurationOrderingEnabledFlag":{
            "title":"Configuration Ordering Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, configuration ordering is enabled for this document style. If false, it isn't enabled.",
            "nullable":false,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ConsignmentTermsEnabledFlag":{
            "title":"Consignment Terms Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, consignment terms are enabled for this document style. If false, they aren't enabled.",
            "nullable":false,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ContractDocumentStyleTypeDisplayName":{
            "maxLength":240,
            "type":"string",
            "description":"Display name of the contract purchase agreement.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ContractDocumentStyleTypeEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the contract purchase agreement is enabled for this document style. If false, it isn't enabled.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the document style.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the document style was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditLineTypesEnabledFlag":{
            "title":"Credit Line Types Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the credit line types are enabled for this document style. If false, they aren't enabled.",
            "nullable":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the document style was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the document style.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineTypeAllowed":{
            "title":"Line Types",
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the line type covers all or needs to be specified. Valid values: All, Specified.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        },
        "LineTypeAllowedCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the allowed line types.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OutsideProcessingEnabledFlag":{
            "title":"Outside Processing Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, outside processing is enabled for this document style. If false, it isn't enabled.",
            "nullable":false,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PriceBreaksEnabledFlag":{
            "title":"Price Breaks Allowed",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, price breaks are enabled for this document style. If false, they aren't enabled.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ProgressPaymentEnabledFlag":{
            "title":"Progress Payments Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, progress payments are enabled for this document style. If false, they aren't enabled.",
            "nullable":false,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "QuantityPurchaseBasisEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the quantity purchase basis is enabled for this document style. If false, it isn't enabled.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RetainageEnabledFlag":{
            "title":"Retainage Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, retainage is enabled for this document style. If false, it isn't enabled.",
            "nullable":false,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "StandardDocumentStyleTypeDisplayName":{
            "maxLength":240,
            "type":"string",
            "description":"Display name of the purchase order.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Status":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"Status of the purchasing document style.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the purchasing document style status.",
            "nullable":false,
            "x-queryable":true
        },
        "StyleDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the purchasing document style.",
            "nullable":true,
            "x-queryable":true
        },
        "StyleId":{
            "type":"integer",
            "description":"The unique identifier of the purchasing document style.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StyleName":{
            "title":"Style",
            "maxLength":240,
            "type":"string",
            "description":"Name that uniquely identifies the purchasing document style.",
            "nullable":false,
            "x-queryable":true
        },
        "StyleType":{
            "maxLength":30,
            "type":"string",
            "description":"Style or format of the purchasing document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkConfirmationEnabledFlag":{
            "title":"Work Confirmation Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, work confirmation is enabled for this document style. If false, it isn't enabled.",
            "nullable":false,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "lineTypes":{
            "title":"Line Types",
            "type":"array",
            "description":"Details of line types",
            "items":{
                "$ref":"#/components/schemas/purchasingDocumentStyles-lineTypes-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Line Types

Type: array

Title: Line Types

Details of line types

Show Source

• Array of: object purchasingDocumentStyles-lineTypes-item-response

{
    "title":"Line Types",
    "type":"array",
    "description":"Details of line types",
    "items":{
        "$ref":"#/components/schemas/purchasingDocumentStyles-lineTypes-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 : purchasingDocumentStyles-lineTypes-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 line type was created.
• EnabledFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, value is allowed for this line type. If false, it isn't allowed.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  User who most recently updated the line type.
• LineTypeId: string
  Maximum Length: 40

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

  The link relations associated with the resource instance.
• StyleId: integer (int64)
  The unique identifier of the purchasing document style.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the line type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the line type was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, value is allowed for this line type. If false, it isn't allowed.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the line type was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the line type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineTypeId":{
            "maxLength":40,
            "type":"string",
            "description":"Value that uniquely identifies the purchasing line type.",
            "nullable":false,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "StyleId":{
            "type":"integer",
            "description":"The unique identifier of the purchasing document style.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            },
            "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

lineTypes

Operation: /fscmRestApi/resources/11.13.18.05/purchasingDocumentStyles/{purchasingDocumentStylesUniqID}/child/lineTypes

Parameters:

• purchasingDocumentStylesUniqID: $request.path.purchasingDocumentStylesUniqID

Details of line types

Back to Top

Examples

This example describes how to update one document style.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/purchasingDocumentStyles/purchasingDocumentStylesUniqID"

For example:

curl -u username:password -X PATCH -H "Content-Type:application/json" -d 'request payload' "https://servername/fscmRestApi/resources/version/purchasingDocumentStyles/300100648901307" 

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
            "StyleDescription": "StyleName-test-1 updated" }

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "StyleId": "300100648901307",
    "StyleName": "StyleName-test-2",
    "StyleDescription": "StyleName-test-1 updated",
    "StyleType": null,
    "Status": "Active",
    "StatusCode": "ACTIVE",
    "QuantityPurchaseBasisEnabledFlag": true,
    "AmountPurchaseBasisEnabledFlag": true,
    "ConsignmentTermsEnabledFlag": false,
    "ConfigurationOrderingEnabledFlag": false,
    "OutsideProcessingEnabledFlag": false,
    "CreditLineTypesEnabledFlag": false,
    "LineTypeAllowed": "All",
    "LineTypeAllowedCode": "ALL",
    "RetainageEnabledFlag": false,
    "ProgressPaymentEnabledFlag": false,
    "WorkConfirmationEnabledFlag": false,
    "PriceBreaksEnabledFlag": false,
    "StandardDocumentStyleTypeDisplayName": "StyleName-test-2-Standard",
    "BlanketDocumentStyleTypeDisplayName": null,
    "BlanketDocumentStyleTypeEnabledFlag": false,
    "ContractDocumentStyleTypeDisplayName": null,
    "ContractDocumentStyleTypeEnabledFlag": false,
    "LastUpdateDate": "2026-01-26T04:17:26+00:00",
    "LastUpdatedBy": "CVBUYER01",
    "CreationDate": "2026-01-26T04:16:24+00:00",
    "CreatedBy": "CVBUYER01",
    "@context": {
        "key": "300100648901307,300100648901307,PURCHASE_BASES,GOODS,300100648901307,PURCHASE_BASES,SERVICES,300100648901307,STANDARD,300100648901307,BLANKET,300100648901307,CONTRACT",
        "headers": {
            "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000006770400000006737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000027371007E00020000000171007E00057372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C71007E000771007E000778"
        },
        "links": [
            {
                "rel": "self",
                "href": "https://servername/fscmRestApi/resources/version/purchasingDocumentStyles/300100648901307%2C300100648901307%2CPURCHASE_BASES%2CGOODS%2C300100648901307%2CPURCHASE_BASES%2CSERVICES%2C300100648901307%2CSTANDARD%2C300100648901307%2CBLANKET%2C300100648901307%2CCONTRACT",
                "name": "purchasingDocumentStyles",
                "kind": "item"
            },
            {
                "rel": "canonical",
                "href": "https://servername/fscmRestApi/resources/version/purchasingDocumentStyles/300100648901307%2C300100648901307%2CPURCHASE_BASES%2CGOODS%2C300100648901307%2CPURCHASE_BASES%2CSERVICES%2C300100648901307%2CSTANDARD%2C300100648901307%2CBLANKET%2C300100648901307%2CCONTRACT",
                "name": "purchasingDocumentStyles",
                "kind": "item"
            },
            {
                "rel": "child",
                "href": "https://servername/fscmRestApi/resources/version/purchasingDocumentStyles/300100648901307%2C300100648901307%2CPURCHASE_BASES%2CGOODS%2C300100648901307%2CPURCHASE_BASES%2CSERVICES%2C300100648901307%2CSTANDARD%2C300100648901307%2CBLANKET%2C300100648901307%2CCONTRACT/child/lineTypes",
                "name": "lineTypes",
                "kind": "collection"
            }
        ]
    }
}

Back to Top