Jump to

• Request
• Response
• Examples

Create one change order template

post

/fscmRestApi/resources/11.13.18.05/purchasingChangeOrderTemplates

Request

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• attributes: array Attributes
  Title: Attributes

  Details of attributes.
• ChangeOrderSeededTemplateId(required): integer (int64)
  Value that uniquely identifies a seeded change order template.
• ChangeOrderTemplateCode(required): string
  Title: Code

  Maximum Length: 30

  Abbreviation identifying the change order template.
• ChangeOrderTemplateId: integer (int64)
  Value that uniquely identifies a change order template.
• ChangeOrderTemplateName(required): string
  Title: Name

  Maximum Length: 240

  Name of the change order template.
• Description: string
  Maximum Length: 240

  Description of the change order template.
• DocumentTypeCode(required): string
  Maximum Length: 25

  Abbreviation identifying the change order template document type.
• StatusCode: string
  Maximum Length: 30

  Abbreviation identifying the change order template status.

{
    "required":[
        "ChangeOrderSeededTemplateId",
        "ChangeOrderTemplateCode",
        "ChangeOrderTemplateName",
        "DocumentTypeCode"
    ],
    "type":"object",
    "properties":{
        "ChangeOrderSeededTemplateId":{
            "type":"integer",
            "description":"Value that uniquely identifies a seeded change order template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ChangeOrderTemplateCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation identifying the change order template.",
            "nullable":false
        },
        "ChangeOrderTemplateId":{
            "type":"integer",
            "description":"Value that uniquely identifies a change order template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ChangeOrderTemplateName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the change order template.",
            "nullable":false
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the change order template.",
            "nullable":true
        },
        "DocumentTypeCode":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation identifying the change order template document type.",
            "nullable":false
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation identifying the change order template status.",
            "nullable":true
        },
        "attributes":{
            "title":"Attributes",
            "type":"array",
            "description":"Details of attributes.",
            "items":{
                "$ref":"#/components/schemas/purchasingChangeOrderTemplates-attributes-item-post-request"
            }
        }
    }
}

Nested Schema : Attributes

Type: array

Title: Attributes

Details of attributes.

Show Source

• Array of: object purchasingChangeOrderTemplates-attributes-item-post-request

{
    "title":"Attributes",
    "type":"array",
    "description":"Details of attributes.",
    "items":{
        "$ref":"#/components/schemas/purchasingChangeOrderTemplates-attributes-item-post-request"
    }
}

Nested Schema : purchasingChangeOrderTemplates-attributes-item-post-request

Type: object

Show Source

• AttributeCode: string
  Maximum Length: 30

  Abbreviation identifying the change order template attribute.
• ChangeOrderTemplateId: integer (int64)
  Value that uniquely identifies a change order template.
• EntityType: string
  Maximum Length: 30

  Entity for which the change order template attribute applies.
• ListOrder: number
  Order of the change order template attribute.
• ReviseDocumentFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the revise document is enabled for this attribute. If false, the revise document isn't enabled.
• UserUpdatableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the attribute can be updated. If false, the attribute can't be updated.

{
    "type":"object",
    "properties":{
        "AttributeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation identifying the change order template attribute.",
            "nullable":false
        },
        "ChangeOrderTemplateId":{
            "type":"integer",
            "description":"Value that uniquely identifies a change order template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EntityType":{
            "maxLength":30,
            "type":"string",
            "description":"Entity for which the change order template attribute applies.",
            "nullable":false
        },
        "ListOrder":{
            "type":"number",
            "description":"Order of the change order template attribute.",
            "nullable":false
        },
        "ReviseDocumentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the revise document is enabled for this attribute. If false, the revise document isn't enabled.",
            "nullable":false
        },
        "UserUpdatableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the attribute can be updated. If false, the attribute can't be updated.",
            "nullable":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 : purchasingChangeOrderTemplates-item-response

Type: object

Show Source

• attributes: array Attributes
  Title: Attributes

  Details of attributes.
• ChangeOrderSeededTemplateId: integer (int64)
  Value that uniquely identifies a seeded change order template.
• ChangeOrderTemplateCode: string
  Title: Code

  Maximum Length: 30

  Abbreviation identifying the change order template.
• ChangeOrderTemplateId: integer (int64)
  Value that uniquely identifies a change order template.
• ChangeOrderTemplateName: string
  Title: Name

  Maximum Length: 240

  Name of the change order template.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the change order template.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the change order template was created.
• Description: string
  Maximum Length: 240

  Description of the change order template.
• DocumentType: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Name of the change order template document type.
• DocumentTypeCode: string
  Maximum Length: 25

  Abbreviation identifying the change order template document type.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the change order template was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the change order template.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Status: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Status of the change order template.
• StatusCode: string
  Maximum Length: 30

  Abbreviation identifying the change order template status.

{
    "type":"object",
    "properties":{
        "ChangeOrderSeededTemplateId":{
            "type":"integer",
            "description":"Value that uniquely identifies a seeded change order template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChangeOrderTemplateCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation identifying the change order template.",
            "nullable":false,
            "x-queryable":true
        },
        "ChangeOrderTemplateId":{
            "type":"integer",
            "description":"Value that uniquely identifies a change order template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChangeOrderTemplateName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the change order template.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the change order template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the change order template was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the change order template.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Name of the change order template document type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentTypeCode":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation identifying the change order template document type.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the change order template 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 change order template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Status of the change order template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation identifying the change order template status.",
            "nullable":true,
            "x-queryable":true
        },
        "attributes":{
            "title":"Attributes",
            "type":"array",
            "description":"Details of attributes.",
            "items":{
                "$ref":"#/components/schemas/purchasingChangeOrderTemplates-attributes-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Attributes

Type: array

Title: Attributes

Details of attributes.

Show Source

• Array of: object purchasingChangeOrderTemplates-attributes-item-response

{
    "title":"Attributes",
    "type":"array",
    "description":"Details of attributes.",
    "items":{
        "$ref":"#/components/schemas/purchasingChangeOrderTemplates-attributes-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 : purchasingChangeOrderTemplates-attributes-item-response

Type: object

Show Source

• AttributeCode: string
  Maximum Length: 30

  Abbreviation identifying the change order template attribute.
• AttributeName: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Name of the change order template attribute.
• ChangeOrderTemplateId: integer (int64)
  Value that uniquely identifies a change order template.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the change order template attribute.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the change order template attribute was created.
• EntityType: string
  Maximum Length: 30

  Entity for which the change order template attribute applies.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the change order template attribute was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the change order template attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListOrder: number
  Order of the change order template attribute.
• ReviseDocumentFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the revise document is enabled for this attribute. If false, the revise document isn't enabled.
• UserUpdatableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the attribute can be updated. If false, the attribute can't be updated.

{
    "type":"object",
    "properties":{
        "AttributeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation identifying the change order template attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeName":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Name of the change order template attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeOrderTemplateId":{
            "type":"integer",
            "description":"Value that uniquely identifies a change order template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the change order template attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the change order template attribute was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityType":{
            "maxLength":30,
            "type":"string",
            "description":"Entity for which the change order template attribute applies.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the change order template attribute 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 change order template attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ListOrder":{
            "type":"number",
            "description":"Order of the change order template attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "ReviseDocumentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the revise document is enabled for this attribute. If false, the revise document isn't enabled.",
            "nullable":false,
            "x-queryable":true
        },
        "UserUpdatableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the attribute can be updated. If false, the attribute can't be updated.",
            "nullable":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

attributes

Operation: /fscmRestApi/resources/11.13.18.05/purchasingChangeOrderTemplates/{ChangeOrderTemplateId}/child/attributes

Parameters:

• ChangeOrderTemplateId: $request.path.ChangeOrderTemplateId

Details of attributes.

validateChangeOrderTemplateIsUsedByADocument

Operation: /fscmRestApi/resources/11.13.18.05/purchasingChangeOrderTemplates/{ChangeOrderTemplateId}/action/validateChangeOrderTemplateIsUsedByADocument

Parameters:

• ChangeOrderTemplateId: $request.path.ChangeOrderTemplateId

Validates that a document type uses the change order template.

Back to Top

Examples

This example describes how to create one change order template.

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/purchasingChangeOrderTemplates"

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/purchasingChangeOrderTemplates"

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.

{
    "ChangeOrderTemplateCode": "TEST_CONTRACT_CODE_TEST",
    "ChangeOrderTemplateName": "TEST_CONTRACT_CODE_TEST_REST",
    "Description": "REST TEST CONTRACT",
    "StatusCode": "ACTIVE",
    "DocumentTypeCode": "CONTRACT",
    "attributes": [
        {
            "EntityType": "HEADER",
            "AttributeCode": "START_DATE",
            "ListOrder": "210",
            "ReviseDocumentFlag": "Y",
            "UserUpdatableFlag": "Y"
        }
    ]
}

Example Response Body

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

{
    "ChangeOrderTemplateId": 300100648583980,
    "ChangeOrderSeededTemplateId": -3,
    "ChangeOrderTemplateCode": "TEST_CONTRACT_CODE_TEST",
    "ChangeOrderTemplateName": "TEST_CONTRACT_CODE_TEST_REST",
    "Description": "REST TEST CONTRACT",
    "StatusCode": "ACTIVE",
    "Status": null,
    "DocumentTypeCode": "CONTRACT",
    "DocumentType": null,
    "CreatedBy": "CVBUYER01",
    "CreationDate": "2026-02-10T02:04:41.001+00:00",
    "LastUpdateDate": "2026-02-10T02:04:41.245+00:00",
    "LastUpdatedBy": "CVBUYER01",
    "attributes": [
        {
            "ChangeOrderTemplateId": 300100648583980,
            "EntityType": "HEADER",
            "AttributeCode": "START_DATE",
            "AttributeName": null,
            "ReviseDocumentFlag": true,
            "UserUpdatableFlag": true,
            "ListOrder": 210,
            "CreatedBy": "CVBUYER01",
            "CreationDate": "2026-02-10T02:04:41.237+00:00",
            "LastUpdateDate": "2026-02-10T02:04:41.318+00:00",
            "LastUpdatedBy": "CVBUYER01",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/purchasingChangeOrderTemplates/300100648583980/child/attributes/00030000000EACED00057708000110F0A08E432C000000064845414445520000000A53544152545F44415445",
                    "name": "attributes",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/purchasingChangeOrderTemplates/300100648583980/child/attributes/00030000000EACED00057708000110F0A08E432C000000064845414445520000000A53544152545F44415445",
                    "name": "attributes",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/purchasingChangeOrderTemplates/300100648583980",
                    "name": "purchasingChangeOrderTemplates",
                    "kind": "item"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/purchasingChangeOrderTemplates/300100648583980",
            "name": "purchasingChangeOrderTemplates",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/purchasingChangeOrderTemplates/300100648583980",
            "name": "purchasingChangeOrderTemplates",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/purchasingChangeOrderTemplates/300100648583980/child/attributes",
            "name": "attributes",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername/fscmRestApi/resources/version/purchasingChangeOrderTemplates/300100648583980/action/validateChangeOrderTemplateIsUsedByADocument",
            "name": "validateChangeOrderTemplateIsUsedByADocument",
            "kind": "other"
        }
    ]
}

Back to Top