Jump to

• Request
• Response

Update a grant for a bank account

patch

/fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountGrants/{GrantId}

Request

Path Parameters

• BankAccountId(required): integer(int64)
  The unique identifier of the bank account.
• GrantId(required): integer(int64)
  The unique identifier of the bank account grant.

Header Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• EndDate: string (date)
  Title: End Date

  The date when the record is inactive.
• RoleName: string
  Maximum Length: 255

  The name of the role of the bank account grant.
• SecureBy: string
  Title: Secure By

  Maximum Length: 255

  The type of the grant. Valid values are Role and User.
• StartDate: string (date)
  The date when the record is active.
• UserName: string
  Maximum Length: 255

  The name of the user of the bank account grant.
• UserRoleName: string
  Maximum Length: 100

  The name of the user or the role name of the grant record.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "type":"string",
            "description":"The date when the record is active.",
            "format":"date",
            "nullable":true
        },
        "UserRoleName":{
            "maxLength":"100",
            "type":"string",
            "description":"The name of the user or the role name of the grant record.",
            "nullable":true
        },
        "SecureBy":{
            "title":"Secure By",
            "maxLength":"255",
            "type":"string",
            "description":"The type of the grant. Valid values are Role and User.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SecureBy1"
                ]
            }
        },
        "RoleName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the role of the bank account grant.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RoleCommonName"
                ]
            }
        },
        "UserName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the user of the bank account grant.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "Username1"
                ]
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the record is inactive.",
            "format":"date",
            "nullable":true
        }
    }
}

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 : cashBankAccounts-bankAccountGrants-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the record was created.
• EndDate: string (date)
  Title: End Date

  The date when the record is inactive.
• GrantId: integer (int64)
  The unique identifier of the bank account grant.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The session login associated to the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RoleName: string
  Maximum Length: 255

  The name of the role of the bank account grant.
• SecureBy: string
  Title: Secure By

  Maximum Length: 255

  The type of the grant. Valid values are Role and User.
• StartDate: string (date)
  The date when the record is active.
• UserName: string
  Maximum Length: 255

  The name of the user of the bank account grant.
• UserRoleName: string
  Maximum Length: 100

  The name of the user or the role name of the grant record.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SecureBy":{
            "title":"Secure By",
            "maxLength":"255",
            "type":"string",
            "description":"The type of the grant. Valid values are Role and User.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SecureBy1"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the user of the bank account grant.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "Username1"
                ]
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the record is inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The date when the record is active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "UserRoleName":{
            "maxLength":"100",
            "type":"string",
            "description":"The name of the user or the role name of the grant record.",
            "nullable":true,
            "x-queryable":true
        },
        "RoleName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the role of the bank account grant.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RoleCommonName"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GrantId":{
            "type":"integer",
            "description":"The unique identifier of the bank account grant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "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."
        }
    }
}

Back to Top