Jump to

• Request
• Response

Update one document type

patch

/fscmRestApi/resources/11.13.18.05/procurementBusinessFunctions/{ProcurementBUId}/child/documentTypes/{documentTypesUniqID}

Request

Path Parameters

• ProcurementBUId(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=
• documentTypesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ProcurementBUId, DocumentTypeCode and DocumentSubtype ---for the Document Types resource and used to uniquely identify an instance of Document Types. The client should not generate the hash key value. Instead, the client should query on the Document Types collection resource with a filter on the primary key values in order to navigate to a specific instance of Document Types.
  
  For example: documentTypes?q=ProcurementBUId=<value1>;DocumentTypeCode=<value2>;DocumentSubtype=<value3>

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

• ChangeOrderTemplateId: integer (int64)
  Title: Change Order Template

  Unique identifier of the change order template.
• ChangeOrderTemplateName: string
  Title: Change Order Template

  Name of the change order template.
• ContractLayout: string
  Title: Contract Terms Layout

  Maximum Length: 240

  Layout used for the contract terms.
• DFF: array DFF
• DisplayName: string
  Title: Display Name

  Maximum Length: 80

  Display name for the document type.
• DocumentLayout: string
  Title: Document Layout

  Maximum Length: 240

  Layout used to format the document.
• DocumentSubtype: string
  Title: Document Subtype

  Maximum Length: 25

  Subtype of the document type.
• DocumentTypeCode: string
  Title: Type

  Maximum Length: 25

  Code that identifies the document type.
• NegotiationLayout: string
  Title: Negotiation Layout

  Maximum Length: 240

  Layout used for the negotiation type.
• NegotiationLayoutForBuyer: string
  Title: Negotiation Layout for Buyer

  Maximum Length: 240

  Layout that buyers use for negotiations.
• NegotiationLayoutForSupplier: string
  Title: Negotiation Layout for Supplier

  Maximum Length: 240

  Layout used for supplier-facing negotiations.
• NegotiationResponseLayout: string
  Title: Response Layout

  Maximum Length: 240

  Layout used for responses in the negotiation.
• TemplateExistsFlag: boolean
  Maximum Length: 1

  Indicates whether a template exists for the document type. Contains one of the following values: true or false. If true, then a template exists for the document type. If false, then a template doesn't exist for the document type. This attribute doesn't have a default value.

{
    "type":"object",
    "properties":{
        "ChangeOrderTemplateId":{
            "title":"Change Order Template",
            "type":"integer",
            "description":"Unique identifier of the change order template.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"default",
                "precision":18
            }
        },
        "ChangeOrderTemplateName":{
            "title":"Change Order Template",
            "type":"string",
            "description":"Name of the change order template.",
            "nullable":true
        },
        "ContractLayout":{
            "title":"Contract Terms Layout",
            "maxLength":240,
            "type":"string",
            "description":"Layout used for the contract terms.",
            "nullable":true
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/procurementBusinessFunctions-documentTypes-DFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":80,
            "type":"string",
            "description":"Display name for the document type.",
            "nullable":true
        },
        "DocumentLayout":{
            "title":"Document Layout",
            "maxLength":240,
            "type":"string",
            "description":"Layout used to format the document.",
            "nullable":true
        },
        "DocumentSubtype":{
            "title":"Document Subtype",
            "maxLength":25,
            "type":"string",
            "description":"Subtype of the document type.",
            "nullable":false
        },
        "DocumentTypeCode":{
            "title":"Type",
            "maxLength":25,
            "type":"string",
            "description":"Code that identifies the document type.",
            "nullable":false
        },
        "NegotiationLayout":{
            "title":"Negotiation Layout",
            "maxLength":240,
            "type":"string",
            "description":"Layout used for the negotiation type.",
            "nullable":true
        },
        "NegotiationLayoutForBuyer":{
            "title":"Negotiation Layout for Buyer",
            "maxLength":240,
            "type":"string",
            "description":"Layout that buyers use for negotiations.",
            "nullable":true
        },
        "NegotiationLayoutForSupplier":{
            "title":"Negotiation Layout for Supplier",
            "maxLength":240,
            "type":"string",
            "description":"Layout used for supplier-facing negotiations.",
            "nullable":true
        },
        "NegotiationResponseLayout":{
            "title":"Response Layout",
            "maxLength":240,
            "type":"string",
            "description":"Layout used for responses in the negotiation.",
            "nullable":true
        },
        "TemplateExistsFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a template exists for the document type. Contains one of the following values: true or false. If true, then a template exists for the document type. If false, then a template doesn't exist for the document type. This attribute doesn't have a default value.",
            "nullable":true
        }
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object procurementBusinessFunctions-documentTypes-DFF-item-patch-request

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

Nested Schema : procurementBusinessFunctions-documentTypes-DFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Prompt

  Maximum Length: 30

  Context Prompt
• __FLEX_Context_DisplayValue: string
  Title: Context Prompt

  Context Prompt
• DocumentSubtype: string
  Maximum Length: 25
• DocumentTypeCode: string
  Title: Type

  Maximum Length: 25
• PrcBuId: integer (int64)

{
    "type":"object",
    "properties":{
        "DocumentSubtype":{
            "maxLength":25,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "DocumentTypeCode":{
            "title":"Type",
            "maxLength":25,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "PrcBuId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "__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 : procurementBusinessFunctions-documentTypes-item-response

Type: object

Show Source

• ChangeOrderTemplateId: integer (int64)
  Title: Change Order Template

  Unique identifier of the change order template.
• ChangeOrderTemplateName: string
  Title: Change Order Template

  Name of the change order template.
• ContractLayout: string
  Title: Contract Terms Layout

  Maximum Length: 240

  Layout used for the contract terms.
• DFF: array DFF
• DisplayName: string
  Title: Display Name

  Maximum Length: 80

  Display name for the document type.
• DocumentLayout: string
  Title: Document Layout

  Maximum Length: 240

  Layout used to format the document.
• DocumentSubtype: string
  Title: Document Subtype

  Maximum Length: 25

  Subtype of the document type.
• DocumentTypeCode: string
  Title: Type

  Maximum Length: 25

  Code that identifies the document type.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date and time when document type was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NegotiationLayout: string
  Title: Negotiation Layout

  Maximum Length: 240

  Layout used for the negotiation type.
• NegotiationLayoutForBuyer: string
  Title: Negotiation Layout for Buyer

  Maximum Length: 240

  Layout that buyers use for negotiations.
• NegotiationLayoutForSupplier: string
  Title: Negotiation Layout for Supplier

  Maximum Length: 240

  Layout used for supplier-facing negotiations.
• NegotiationResponseLayout: string
  Title: Response Layout

  Maximum Length: 240

  Layout used for responses in the negotiation.
• ProcurementBUId: integer (int64)
  Title: Procurement BU

  Read Only: true

  Value that uniquely identifies a business unit.
• TemplateExistsFlag: boolean
  Maximum Length: 1

  Indicates whether a template exists for the document type. Contains one of the following values: true or false. If true, then a template exists for the document type. If false, then a template doesn't exist for the document type. This attribute doesn't have a default value.

{
    "type":"object",
    "properties":{
        "ChangeOrderTemplateId":{
            "title":"Change Order Template",
            "type":"integer",
            "description":"Unique identifier of the change order template.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"default",
                "precision":18
            },
            "x-queryable":true
        },
        "ChangeOrderTemplateName":{
            "title":"Change Order Template",
            "type":"string",
            "description":"Name of the change order template.",
            "nullable":true,
            "x-queryable":true
        },
        "ContractLayout":{
            "title":"Contract Terms Layout",
            "maxLength":240,
            "type":"string",
            "description":"Layout used for the contract terms.",
            "nullable":true,
            "x-queryable":true
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/procurementBusinessFunctions-documentTypes-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":80,
            "type":"string",
            "description":"Display name for the document type.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentLayout":{
            "title":"Document Layout",
            "maxLength":240,
            "type":"string",
            "description":"Layout used to format the document.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentSubtype":{
            "title":"Document Subtype",
            "maxLength":25,
            "type":"string",
            "description":"Subtype of the document type.",
            "nullable":false,
            "x-queryable":true
        },
        "DocumentTypeCode":{
            "title":"Type",
            "maxLength":25,
            "type":"string",
            "description":"Code that identifies the document type.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when document type was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NegotiationLayout":{
            "title":"Negotiation Layout",
            "maxLength":240,
            "type":"string",
            "description":"Layout used for the negotiation type.",
            "nullable":true,
            "x-queryable":true
        },
        "NegotiationLayoutForBuyer":{
            "title":"Negotiation Layout for Buyer",
            "maxLength":240,
            "type":"string",
            "description":"Layout that buyers use for negotiations.",
            "nullable":true,
            "x-queryable":true
        },
        "NegotiationLayoutForSupplier":{
            "title":"Negotiation Layout for Supplier",
            "maxLength":240,
            "type":"string",
            "description":"Layout used for supplier-facing negotiations.",
            "nullable":true,
            "x-queryable":true
        },
        "NegotiationResponseLayout":{
            "title":"Response Layout",
            "maxLength":240,
            "type":"string",
            "description":"Layout used for responses in the negotiation.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "title":"Procurement BU",
            "type":"integer",
            "description":"Value that uniquely identifies a business unit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TemplateExistsFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a template exists for the document type. Contains one of the following values: true or false. If true, then a template exists for the document type. If false, then a template doesn't exist for the document type. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "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 procurementBusinessFunctions-documentTypes-DFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/procurementBusinessFunctions-documentTypes-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 : procurementBusinessFunctions-documentTypes-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
• DocumentSubtype: string
  Maximum Length: 25
• DocumentTypeCode: string
  Title: Type

  Maximum Length: 25
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrcBuId: integer (int64)

{
    "type":"object",
    "properties":{
        "DocumentSubtype":{
            "maxLength":25,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DocumentTypeCode":{
            "title":"Type",
            "maxLength":25,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PrcBuId":{
            "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/procurementBusinessFunctions/{ProcurementBUId}/child/documentTypes/{documentTypesUniqID}/child/DFF

Parameters:

• ProcurementBUId: $request.path.ProcurementBUId
• documentTypesUniqID: $request.path.documentTypesUniqID

Back to Top