Jump to

• Request
• Response
• Examples

Create one line type

post

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

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

• 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.
• LineTypeId: string
  Maximum Length: 40

  Value that uniquely identifies the purchasing line type.
• StyleId: integer (int64)
  The unique identifier of the purchasing document style.

{
    "type":"object",
    "properties":{
        "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
        },
        "LineTypeId":{
            "maxLength":40,
            "type":"string",
            "description":"Value that uniquely identifies the purchasing line type.",
            "nullable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "StyleId":{
            "type":"integer",
            "description":"The unique identifier of the purchasing document style.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        }
    }
}

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

Back to Top

Examples

This example describes how to create one line type.

Example cURL Command

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

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

For example:

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

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.

{
            "StyleName": "StyleName-test-3",
            "StyleDescription": "StyleName-test-3",
            "StatusCode": "ACTIVE",
            "QuantityPurchaseBasisEnabledFlag": true,
            "AmountPurchaseBasisEnabledFlag": true,           
            "ConfigurationOrderingEnabledFlag": false,
            "ConsignmentTermsEnabledFlag": false,
            "OutsideProcessingEnabledFlag": false,
            "CreditLineTypesEnabledFlag": false,
            "LineTypeAllowedCode": "SPECIFIED",           
            "RetainageEnabledFlag": false,
            "ProgressPaymentEnabledFlag": false,
            "WorkConfirmationEnabledFlag": false,
            "PriceBreaksEnabledFlag": false,
            "StandardDocumentStyleTypeDisplayName": "StyleName-test-3-Standard",
            "lineTypes": [
               {
                   "LineTypeId": "100000015814034"
               },
                              {
                   "LineTypeId": "1"
               }
            ]
}

Example Response Body

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

{
    "StyleId": "300100648937639",
    "StyleName": "StyleName-test-3",
    "StyleDescription": "StyleName-test-3",
    "StyleType": null,
    "Status": "Active",
    "StatusCode": "ACTIVE",
    "QuantityPurchaseBasisEnabledFlag": true,
    "AmountPurchaseBasisEnabledFlag": true,
    "ConsignmentTermsEnabledFlag": false,
    "ConfigurationOrderingEnabledFlag": false,
    "OutsideProcessingEnabledFlag": false,
    "CreditLineTypesEnabledFlag": false,
    "LineTypeAllowed": "Specified",
    "LineTypeAllowedCode": "SPECIFIED",
    "RetainageEnabledFlag": false,
    "ProgressPaymentEnabledFlag": false,
    "WorkConfirmationEnabledFlag": false,
    "PriceBreaksEnabledFlag": false,
    "StandardDocumentStyleTypeDisplayName": "StyleName-test-3-Standard",
    "BlanketDocumentStyleTypeDisplayName": null,
    "BlanketDocumentStyleTypeEnabledFlag": false,
    "ContractDocumentStyleTypeDisplayName": null,
    "ContractDocumentStyleTypeEnabledFlag": false,
    "LastUpdateDate": "2026-01-26T04:20:29.297+00:00",
    "LastUpdatedBy": "CVBUYER01",
    "CreationDate": "2026-01-26T04:20:29+00:00",
    "CreatedBy": "CVBUYER01",
    "lineTypes": {
        "items": [
            {
                "LineTypeId": "100000015814034",
                "StyleId": "300100648937639",
                "EnabledFlag": true,
                "LastUpdateDate": "2026-01-26T04:20:29.399+00:00",
                "LastUpdatedBy": "CVBUYER01",
                "CreationDate": "2026-01-26T04:20:29.275+00:00",
                "CreatedBy": "CVBUYER01",
                "@context": {
                    "key": "100000015814034,LINE_TYPES,300100648937639",
                    "headers": {
                        "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    },
                    "links": [
                        {
                            "rel": "self",
                            "href": "https://servername/fscmRestApi/resources/version/purchasingDocumentStyles/300100648937639%2C300100648937639%2CPURCHASE_BASES%2CGOODS%2C300100648937639%2CPURCHASE_BASES%2CSERVICES%2C300100648937639%2CSTANDARD%2C300100648937639%2CBLANKET%2C300100648937639%2CCONTRACT/child/lineTypes/100000015814034%2CLINE_TYPES%2C300100648937639",
                            "name": "lineTypes",
                            "kind": "item"
                        },
                        {
                            "rel": "canonical",
                            "href": "https://servername/fscmRestApi/resources/version/purchasingDocumentStyles/300100648937639%2C300100648937639%2CPURCHASE_BASES%2CGOODS%2C300100648937639%2CPURCHASE_BASES%2CSERVICES%2C300100648937639%2CSTANDARD%2C300100648937639%2CBLANKET%2C300100648937639%2CCONTRACT/child/lineTypes/100000015814034%2CLINE_TYPES%2C300100648937639",
                            "name": "lineTypes",
                            "kind": "item"
                        },
                        {
                            "rel": "parent",
                            "href": "https://servername/fscmRestApi/resources/version/purchasingDocumentStyles/300100648937639%2C300100648937639%2CPURCHASE_BASES%2CGOODS%2C300100648937639%2CPURCHASE_BASES%2CSERVICES%2C300100648937639%2CSTANDARD%2C300100648937639%2CBLANKET%2C300100648937639%2CCONTRACT",
                            "name": "purchasingDocumentStyles",
                            "kind": "item"
                        }
                    ]
                }
            },
            {
                "LineTypeId": "1",
                "StyleId": "300100648937639",
                "EnabledFlag": true,
                "LastUpdateDate": "2026-01-26T04:20:29.403+00:00",
                "LastUpdatedBy": "CVBUYER01",
                "CreationDate": "2026-01-26T04:20:29.276+00:00",
                "CreatedBy": "CVBUYER01",
                "@context": {
                    "key": "1,LINE_TYPES,300100648937639",
                    "headers": {
                        "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    },
                    "links": [
                        {
                            "rel": "self",
                            "href": "https://servername/fscmRestApi/resources/version/purchasingDocumentStyles/300100648937639%2C300100648937639%2CPURCHASE_BASES%2CGOODS%2C300100648937639%2CPURCHASE_BASES%2CSERVICES%2C300100648937639%2CSTANDARD%2C300100648937639%2CBLANKET%2C300100648937639%2CCONTRACT/child/lineTypes/1%2CLINE_TYPES%2C300100648937639",
                            "name": "lineTypes",
                            "kind": "item"
                        },
                        {
                            "rel": "canonical",
                            "href": "https://servername/fscmRestApi/resources/version/purchasingDocumentStyles/300100648937639%2C300100648937639%2CPURCHASE_BASES%2CGOODS%2C300100648937639%2CPURCHASE_BASES%2CSERVICES%2C300100648937639%2CSTANDARD%2C300100648937639%2CBLANKET%2C300100648937639%2CCONTRACT/child/lineTypes/1%2CLINE_TYPES%2C300100648937639",
                            "name": "lineTypes",
                            "kind": "item"
                        },
                        {
                            "rel": "parent",
                            "href": "https://servername/fscmRestApi/resources/version/purchasingDocumentStyles/300100648937639%2C300100648937639%2CPURCHASE_BASES%2CGOODS%2C300100648937639%2CPURCHASE_BASES%2CSERVICES%2C300100648937639%2CSTANDARD%2C300100648937639%2CBLANKET%2C300100648937639%2CCONTRACT",
                            "name": "purchasingDocumentStyles",
                            "kind": "item"
                        }
                    ]
                }
            }
        ],
        "count": 2,
        "hasMore": false,
        "limit": 25,
        "offset": 0,
        "links": [
            {
                "rel": "self",
                "href": "https://servername/fscmRestApi/resources/version/purchasingDocumentStyles/300100648937639%2C300100648937639%2CPURCHASE_BASES%2CGOODS%2C300100648937639%2CPURCHASE_BASES%2CSERVICES%2C300100648937639%2CSTANDARD%2C300100648937639%2CBLANKET%2C300100648937639%2CCONTRACT/child/lineTypes",
                "name": "lineTypes",
                "kind": "collection"
            }
        ]
    },
    "@context": {
        "key": "300100648937639,300100648937639,PURCHASE_BASES,GOODS,300100648937639,PURCHASE_BASES,SERVICES,300100648937639,STANDARD,300100648937639,BLANKET,300100648937639,CONTRACT",
        "headers": {
            "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000006770400000006737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000017371007E0002000000017371007E0002000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C71007E000871007E000878"
        },
        "links": [
            {
                "rel": "self",
                "href": "https://servername/fscmRestApi/resources/version/purchasingDocumentStyles/300100648937639%2C300100648937639%2CPURCHASE_BASES%2CGOODS%2C300100648937639%2CPURCHASE_BASES%2CSERVICES%2C300100648937639%2CSTANDARD%2C300100648937639%2CBLANKET%2C300100648937639%2CCONTRACT",
                "name": "purchasingDocumentStyles",
                "kind": "item"
            },
            {
                "rel": "canonical",
                "href": "https://servername/fscmRestApi/resources/version/purchasingDocumentStyles/300100648937639%2C300100648937639%2CPURCHASE_BASES%2CGOODS%2C300100648937639%2CPURCHASE_BASES%2CSERVICES%2C300100648937639%2CSTANDARD%2C300100648937639%2CBLANKET%2C300100648937639%2CCONTRACT",
                "name": "purchasingDocumentStyles",
                "kind": "item"
            },
            {
                "rel": "child",
                "href": "https://servername/fscmRestApi/resources/version/purchasingDocumentStyles/300100648937639%2C300100648937639%2CPURCHASE_BASES%2CGOODS%2C300100648937639%2CPURCHASE_BASES%2CSERVICES%2C300100648937639%2CSTANDARD%2C300100648937639%2CBLANKET%2C300100648937639%2CCONTRACT/child/lineTypes",
                "name": "lineTypes",
                "kind": "collection"
            }
        ]
    }
}

Back to Top