Jump to

• Request
• Response

Update one document numbering

patch

/fscmRestApi/resources/11.13.18.05/procurementDocumentNumberings/{DocumentNumberId}

Request

Path Parameters

• DocumentNumberId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BusinessUnitId: integer (int64)
  Title: Determinant Value

  Default Value: -1

  Value that uniquely identifies a business unit.
• CurrentMaximumUniqueIdentifier: integer (int64)
  Title: Next Number

  Default Value: 0

  Current value for the unique identifier.
• DeterminantType: string
  Title: Determinant Type

  Maximum Length: 32

  Default Value: SOLD_TO_LE

  Abbreviation that identifies a determinant type.
• DocumentNumberId: integer (int64)
  Value that uniquely identifies a document numbering.
• LegalEntityId: integer (int64)
  Title: Determinant Value

  Default Value: -1

  Value that uniquely identifies a legal entity.
• MinimumDigits: integer (int64)
  Title: Minimum Digits

  Minimum number of digits the generated identifier should contain.
• ObjectVersionNumber: integer (int32)
  Number that's incremented whenever a row is updated.
• Prefix: string
  Title: Prefix

  Maximum Length: 30

  Prefix of the unique identifier.
• Preview: string
  Title: Preview

  Concatenates the Prefix, Next Number, and Suffix.
• Suffix: string
  Title: Suffix

  Maximum Length: 30

  Suffix of the unique identifier.
• TableName: string
  Title: Document Type

  Maximum Length: 32

  Default Value: PURCHASE_ORDER

  Name of the table for the unique identifier.

{
    "type":"object",
    "properties":{
        "BusinessUnitId":{
            "title":"Determinant Value",
            "type":"integer",
            "description":"Value that uniquely identifies a business unit.",
            "format":"int64",
            "nullable":false,
            "default":-1,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "CurrentMaximumUniqueIdentifier":{
            "title":"Next Number",
            "type":"integer",
            "description":"Current value for the unique identifier.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            }
        },
        "DeterminantType":{
            "title":"Determinant Type",
            "maxLength":32,
            "type":"string",
            "description":"Abbreviation that identifies a determinant type.",
            "nullable":true,
            "default":"SOLD_TO_LE"
        },
        "DocumentNumberId":{
            "type":"integer",
            "description":"Value that uniquely identifies a document numbering.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LegalEntityId":{
            "title":"Determinant Value",
            "type":"integer",
            "description":"Value that uniquely identifies a legal entity.",
            "format":"int64",
            "nullable":false,
            "default":-1,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "MinimumDigits":{
            "title":"Minimum Digits",
            "type":"integer",
            "description":"Minimum number of digits the generated identifier should contain.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that's incremented whenever a row is updated.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9,
                "sortable":false
            }
        },
        "Prefix":{
            "title":"Prefix",
            "maxLength":30,
            "type":"string",
            "description":"Prefix of the unique identifier.",
            "nullable":true
        },
        "Preview":{
            "title":"Preview",
            "type":"string",
            "description":"Concatenates the Prefix, Next Number, and Suffix.",
            "nullable":true,
            "x-queryable":false
        },
        "Suffix":{
            "title":"Suffix",
            "maxLength":30,
            "type":"string",
            "description":"Suffix of the unique identifier.",
            "nullable":true
        },
        "TableName":{
            "title":"Document Type",
            "maxLength":32,
            "type":"string",
            "description":"Name of the table for the unique identifier.",
            "nullable":false,
            "default":"PURCHASE_ORDER"
        }
    }
}

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

Type: object

Show Source

• BusinessUnitId: integer (int64)
  Title: Determinant Value

  Default Value: -1

  Value that uniquely identifies a business unit.
• BusinessUnitName: string
  Title: Business Unit

  Read Only: true

  Maximum Length: 240

  Name of the business unit.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the document numbering was created.
• CurrentMaximumUniqueIdentifier: integer (int64)
  Title: Next Number

  Default Value: 0

  Current value for the unique identifier.
• DeterminantType: string
  Title: Determinant Type

  Maximum Length: 32

  Default Value: SOLD_TO_LE

  Abbreviation that identifies a determinant type.
• DeterminantTypeName: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Name for a determinant type.
• DocumentNumberId: integer (int64)
  Value that uniquely identifies a document numbering.
• DocumentType: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Type of document.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  User who most recently updated the document numbering.
• LegalEntityId: integer (int64)
  Title: Determinant Value

  Default Value: -1

  Value that uniquely identifies a legal entity.
• LegalEntityName: string
  Title: Legal Entity Name

  Read Only: true

  Maximum Length: 240

  Name of the legal entity.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MinimumDigits: integer (int64)
  Title: Minimum Digits

  Minimum number of digits the generated identifier should contain.
• ObjectVersionNumber: integer (int32)
  Number that's incremented whenever a row is updated.
• Prefix: string
  Title: Prefix

  Maximum Length: 30

  Prefix of the unique identifier.
• Preview: string
  Title: Preview

  Concatenates the Prefix, Next Number, and Suffix.
• Suffix: string
  Title: Suffix

  Maximum Length: 30

  Suffix of the unique identifier.
• TableName: string
  Title: Document Type

  Maximum Length: 32

  Default Value: PURCHASE_ORDER

  Name of the table for the unique identifier.

{
    "type":"object",
    "properties":{
        "BusinessUnitId":{
            "title":"Determinant Value",
            "type":"integer",
            "description":"Value that uniquely identifies a business unit.",
            "format":"int64",
            "nullable":false,
            "default":-1,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the document numbering.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the document numbering was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CurrentMaximumUniqueIdentifier":{
            "title":"Next Number",
            "type":"integer",
            "description":"Current value for the unique identifier.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeterminantType":{
            "title":"Determinant Type",
            "maxLength":32,
            "type":"string",
            "description":"Abbreviation that identifies a determinant type.",
            "nullable":true,
            "default":"SOLD_TO_LE",
            "x-queryable":true
        },
        "DeterminantTypeName":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Name for a determinant type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentNumberId":{
            "type":"integer",
            "description":"Value that uniquely identifies a document numbering.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DocumentType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Type of document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the document numbering.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the document numbering.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LegalEntityId":{
            "title":"Determinant Value",
            "type":"integer",
            "description":"Value that uniquely identifies a legal entity.",
            "format":"int64",
            "nullable":false,
            "default":-1,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "LegalEntityName":{
            "title":"Legal Entity Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the legal entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumDigits":{
            "title":"Minimum Digits",
            "type":"integer",
            "description":"Minimum number of digits the generated identifier should contain.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that's incremented whenever a row is updated.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9,
                "sortable":false
            }
        },
        "Prefix":{
            "title":"Prefix",
            "maxLength":30,
            "type":"string",
            "description":"Prefix of the unique identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "Preview":{
            "title":"Preview",
            "type":"string",
            "description":"Concatenates the Prefix, Next Number, and Suffix.",
            "nullable":true,
            "x-queryable":false
        },
        "Suffix":{
            "title":"Suffix",
            "maxLength":30,
            "type":"string",
            "description":"Suffix of the unique identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "TableName":{
            "title":"Document Type",
            "maxLength":32,
            "type":"string",
            "description":"Name of the table for the unique identifier.",
            "nullable":false,
            "default":"PURCHASE_ORDER",
            "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