Jump to

• Request
• Response

Update one inventory organization

patch

/fscmRestApi/resources/11.13.18.05/electronicSignaturePreferences/{SignatureOrganizationId}

Request

Path Parameters

• SignatureOrganizationId(required): integer(int64)
  Value that uniquely identifies the electronic signature preferences setup for an inventory organization.

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

• electronicSignatureTransactionTypes: array Electronic Signature Transaction Types
  Title: Electronic Signature Transaction Types

  The Electronic Signature Transaction Types resource displays the details about the electronic signature preferences for supply chain transactions.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization for which electronic signature preferences are configured.
• SignatureOrganizationId: integer (int64)
  Value that uniquely identifies the electronic signature preferences setup for an inventory organization.

{
    "type":"object",
    "properties":{
        "SignatureOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the electronic signature preferences setup for an inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "electronicSignatureTransactionTypes":{
            "title":"Electronic Signature Transaction Types",
            "type":"array",
            "description":"The Electronic Signature Transaction Types resource displays the details about the electronic signature preferences for supply chain transactions.",
            "items":{
                "$ref":"#/components/schemas/electronicSignaturePreferences-electronicSignatureTransactionTypes-item-patch-request"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization for which electronic signature preferences are configured.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : Electronic Signature Transaction Types

Type: array

Title: Electronic Signature Transaction Types

The Electronic Signature Transaction Types resource displays the details about the electronic signature preferences for supply chain transactions.

Show Source

• Array of: object schema

{
    "title":"Electronic Signature Transaction Types",
    "type":"array",
    "description":"The Electronic Signature Transaction Types resource displays the details about the electronic signature preferences for supply chain transactions.",
    "items":{
        "$ref":"#/components/schemas/electronicSignaturePreferences-electronicSignatureTransactionTypes-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• SignatureDefinitionId: integer (int64)
  Value that uniquely identifies the electronic signature preference lines for an inventory organization.
• SignatureEnabledFlag: boolean
  Title: Signature Enabled

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then electronic signature is enabled for a transaction type. If false, then electronic signature is not enabled for a transaction type. The default value is false.
• SignatureModeEditableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then electronic signature mode is editable for a transaction type. If false, then electronic signature mode cannot be editable for a transaction type. The default value is false.
• SignatureOrganizationId: integer (int64)
  Value that uniquely identifies the electronic signature preference header for an inventory organization.
• SignatureTypeCode: string
  Title: Signature Type

  Maximum Length: 30

  Abbreviation that identifies electronic signature type for a transaction type. A list of accepted values: INLINE and DEFERRED is defined in the lookup type ORA_EDR_SIGNATURE_MODE.
• TransactionTypeCode: string
  Maximum Length: 30

  Abbreviation that uniquely identifies the transaction type for which electronic signature can be enabled.

{
    "type":"object",
    "properties":{
        "SignatureDefinitionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the electronic signature preference lines for an inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "SignatureTypeCode":{
            "title":"Signature Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies electronic signature type for a transaction type. A list of accepted values: INLINE and DEFERRED is defined in the lookup type ORA_EDR_SIGNATURE_MODE.",
            "nullable":false
        },
        "SignatureModeEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then electronic signature mode is editable for a transaction type. If false, then electronic signature mode cannot be editable for a transaction type. The default value is false.",
            "nullable":true
        },
        "TransactionTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the transaction type for which electronic signature can be enabled.",
            "nullable":false
        },
        "SignatureOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the electronic signature preference header for an inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SignatureEnabledFlag":{
            "title":"Signature Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then electronic signature is enabled for a transaction type. If false, then electronic signature is not enabled for a transaction type. The default value is false.",
            "nullable":false,
            "default":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 : electronicSignaturePreferences-item-response

Type: object

Show Source

• electronicSignatureTransactionTypes: array Electronic Signature Transaction Types
  Title: Electronic Signature Transaction Types

  The Electronic Signature Transaction Types resource displays the details about the electronic signature preferences for supply chain transactions.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationCode: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that uniquely identifies the inventory organization for which electronic signature preferences are configured.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization for which electronic signature preferences are configured.
• OrganizationName: string
  Read Only: true

  Maximum Length: 240

  Name of the inventory organization for which electronic signature preferences are configured.
• SignatureOrganizationId: integer (int64)
  Value that uniquely identifies the electronic signature preferences setup for an inventory organization.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the inventory organization for which electronic signature preferences are configured.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the inventory organization for which electronic signature preferences are configured.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "electronicSignatureTransactionTypes":{
            "title":"Electronic Signature Transaction Types",
            "type":"array",
            "description":"The Electronic Signature Transaction Types resource displays the details about the electronic signature preferences for supply chain transactions.",
            "items":{
                "$ref":"#/components/schemas/electronicSignaturePreferences-electronicSignatureTransactionTypes-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization for which electronic signature preferences are configured.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SignatureOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the electronic signature preferences setup for an inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Electronic Signature Transaction Types

Type: array

Title: Electronic Signature Transaction Types

The Electronic Signature Transaction Types resource displays the details about the electronic signature preferences for supply chain transactions.

Show Source

• Array of: object electronicSignaturePreferences-electronicSignatureTransactionTypes-item-response

{
    "title":"Electronic Signature Transaction Types",
    "type":"array",
    "description":"The Electronic Signature Transaction Types resource displays the details about the electronic signature preferences for supply chain transactions.",
    "items":{
        "$ref":"#/components/schemas/electronicSignaturePreferences-electronicSignatureTransactionTypes-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 : electronicSignaturePreferences-electronicSignatureTransactionTypes-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SignatureDefinitionId: integer (int64)
  Value that uniquely identifies the electronic signature preference lines for an inventory organization.
• SignatureEnabledFlag: boolean
  Title: Signature Enabled

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then electronic signature is enabled for a transaction type. If false, then electronic signature is not enabled for a transaction type. The default value is false.
• SignatureModeEditableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then electronic signature mode is editable for a transaction type. If false, then electronic signature mode cannot be editable for a transaction type. The default value is false.
• SignatureOrganizationId: integer (int64)
  Value that uniquely identifies the electronic signature preference header for an inventory organization.
• SignatureType: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Type of electronic signature for a transaction type. A list of accepted values: Inline and Deferred is defined in the lookup type ORA_EDR_SIGNATURE_MODE.
• SignatureTypeCode: string
  Title: Signature Type

  Maximum Length: 30

  Abbreviation that identifies electronic signature type for a transaction type. A list of accepted values: INLINE and DEFERRED is defined in the lookup type ORA_EDR_SIGNATURE_MODE.
• Transaction: string
  Title: Transaction

  Read Only: true

  Maximum Length: 150

  Name of the transaction type for which electronic signature can be enabled.
• TransactionTypeCode: string
  Maximum Length: 30

  Abbreviation that uniquely identifies the transaction type for which electronic signature can be enabled.
• TransactionTypeId: integer (int64)
  Read Only: true

  Value that uniquely identifies the transaction type for which electronic signature can be enabled.

{
    "type":"object",
    "properties":{
        "SignatureDefinitionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the electronic signature preference lines for an inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SignatureTypeCode":{
            "title":"Signature Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies electronic signature type for a transaction type. A list of accepted values: INLINE and DEFERRED is defined in the lookup type ORA_EDR_SIGNATURE_MODE.",
            "nullable":false,
            "x-queryable":true
        },
        "Transaction":{
            "title":"Transaction",
            "maxLength":150,
            "type":"string",
            "description":"Name of the transaction type for which electronic signature can be enabled.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SignatureModeEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then electronic signature mode is editable for a transaction type. If false, then electronic signature mode cannot be editable for a transaction type. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transaction type for which electronic signature can be enabled.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TransactionTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the transaction type for which electronic signature can be enabled.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SignatureType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Type of electronic signature for a transaction type. A list of accepted values: Inline and Deferred is defined in the lookup type ORA_EDR_SIGNATURE_MODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SignatureOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the electronic signature preference header for an inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SignatureEnabledFlag":{
            "title":"Signature Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then electronic signature is enabled for a transaction type. If false, then electronic signature is not enabled for a transaction type. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        }
    }
}

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

electronicSignatureTransactionTypes

Operation: /fscmRestApi/resources/11.13.18.05/electronicSignaturePreferences/{SignatureOrganizationId}/child/electronicSignatureTransactionTypes

Parameters:

• SignatureOrganizationId: $request.path.SignatureOrganizationId

The Electronic Signature Transaction Types resource displays the details about the electronic signature preferences for supply chain transactions.

Back to Top