Jump to

• Request
• Response

Update a federal account attribute

patch

/fscmRestApi/resources/11.13.18.05/fedAccountAttributes/{AccountAttributeHeaderId}

Request

Path Parameters

• AccountAttributeHeaderId(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:
  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

• fedAccountAttributeLines: array Federal Account Attribute Lines
  Title: Federal Account Attribute Lines

  The federal account attribute lines enable users to manage account attribute with lines.
• Ledger: string
  Title: Ledger

  Maximum Length: 255

  Name of the ledger associated with the federal account attribute.
• Summary: string
  Title: Summary

  Maximum Length: 255

  Type of the natural account associated with the federal account attribute.

{
    "type":"object",
    "properties":{
        "Summary":{
            "title":"Summary",
            "maxLength":"255",
            "type":"string",
            "description":"Type of the natural account associated with the federal account attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SummaryFlagLookupCode",
                    "SummaryFlagMeaning"
                ]
            }
        },
        "Ledger":{
            "title":"Ledger",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the ledger associated with the federal account attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LedgerId",
                    "Name"
                ]
            }
        },
        "fedAccountAttributeLines":{
            "title":"Federal Account Attribute Lines",
            "type":"array",
            "description":"The federal account attribute lines enable users to manage account attribute with lines.",
            "items":{
                "$ref":"#/components/schemas/fedAccountAttributes-fedAccountAttributeLines-item-patch-request"
            }
        }
    }
}

Nested Schema : Federal Account Attribute Lines

Type: array

Title: Federal Account Attribute Lines

The federal account attribute lines enable users to manage account attribute with lines.

Show Source

• Array of: object fedAccountAttributes-fedAccountAttributeLines-item-patch-request

{
    "title":"Federal Account Attribute Lines",
    "type":"array",
    "description":"The federal account attribute lines enable users to manage account attribute with lines.",
    "items":{
        "$ref":"#/components/schemas/fedAccountAttributes-fedAccountAttributeLines-item-patch-request"
    }
}

Nested Schema : fedAccountAttributes-fedAccountAttributeLines-item-patch-request

Type: object

Show Source

• AttributeValue: string
  Title: Value

  Maximum Length: 255

  Value of the federal attribute.
• FederalAttributeName: string
  Title: Federal Attribute Name

  Maximum Length: 255

  Name of the federal attribute associated with the federal account attribute line.
• FromPeriodName: string
  Title: From Period

  Maximum Length: 15

  Name of the starting period associated with the federal account attribute line.
• ToPeriodName: string
  Title: To Period

  Maximum Length: 15

  Name of the ending period associated with the federal account attribute line.

{
    "type":"object",
    "properties":{
        "AttributeValue":{
            "title":"Value",
            "maxLength":"255",
            "type":"string",
            "description":"Value of the federal attribute.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "FederalAttributeName"
                ]
            }
        },
        "FederalAttributeName":{
            "title":"Federal Attribute Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the federal attribute associated with the federal account attribute line.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "FederalAttributeId"
                ]
            }
        },
        "FromPeriodName":{
            "title":"From Period",
            "maxLength":"15",
            "type":"string",
            "description":"Name of the starting period associated with the federal account attribute line.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "FederalAttributeName"
                ]
            }
        },
        "ToPeriodName":{
            "title":"To Period",
            "maxLength":"15",
            "type":"string",
            "description":"Name of the ending period associated with the federal account attribute line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "FederalAttributeName"
                ]
            }
        }
    }
}

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

Type: object

Show Source

• AccountAttributeHeaderId: integer (int64)
  Title: Account Attribute Header ID

  The unique identifier of the federal account attribute.
• AccountDescription: string
  Title: Account Description

  Read Only: true

  Maximum Length: 255

  A brief description of the federal account attribute.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the record was created.
• fedAccountAttributeLines: array Federal Account Attribute Lines
  Title: Federal Account Attribute Lines

  The federal account attribute lines enable users to manage account attribute with lines.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  The user who last updated the record.
• Ledger: string
  Title: Ledger

  Maximum Length: 255

  Name of the ledger associated with the federal account attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NaturalAccountValue: string
  Title: Account

  Maximum Length: 25

  Natural account associated with the federal account attribute.
• Summary: string
  Title: Summary

  Maximum Length: 255

  Type of the natural account associated with the federal account attribute.

{
    "type":"object",
    "properties":{
        "AccountDescription":{
            "title":"Account Description",
            "maxLength":"255",
            "type":"string",
            "description":"A brief description of the federal account attribute.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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 when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "fedAccountAttributeLines":{
            "title":"Federal Account Attribute Lines",
            "type":"array",
            "description":"The federal account attribute lines enable users to manage account attribute with lines.",
            "items":{
                "$ref":"#/components/schemas/fedAccountAttributes-fedAccountAttributeLines-item-response"
            }
        },
        "NaturalAccountValue":{
            "title":"Account",
            "maxLength":"25",
            "type":"string",
            "description":"Natural account associated with the federal account attribute.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "NaturalAccountValueSetId"
                ]
            },
            "x-queryable":true
        },
        "Ledger":{
            "title":"Ledger",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the ledger associated with the federal account attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LedgerId",
                    "Name"
                ]
            },
            "x-queryable":true
        },
        "Summary":{
            "title":"Summary",
            "maxLength":"255",
            "type":"string",
            "description":"Type of the natural account associated with the federal account attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SummaryFlagLookupCode",
                    "SummaryFlagMeaning"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AccountAttributeHeaderId":{
            "title":"Account Attribute Header ID",
            "type":"integer",
            "description":"The unique identifier of the federal account attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Federal Account Attribute Lines

Type: array

Title: Federal Account Attribute Lines

The federal account attribute lines enable users to manage account attribute with lines.

Show Source

• Array of: object fedAccountAttributes-fedAccountAttributeLines-item-response

{
    "title":"Federal Account Attribute Lines",
    "type":"array",
    "description":"The federal account attribute lines enable users to manage account attribute with lines.",
    "items":{
        "$ref":"#/components/schemas/fedAccountAttributes-fedAccountAttributeLines-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 : fedAccountAttributes-fedAccountAttributeLines-item-response

Type: object

Show Source

• AccountAttributeLineId: integer (int64)
  Title: Account Attribute Line ID

  The unique identifier of the federal account attribute line.
• AttributeValue: string
  Title: Value

  Maximum Length: 255

  Value of the federal attribute.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the record was created.
• FederalAttributeName: string
  Title: Federal Attribute Name

  Maximum Length: 255

  Name of the federal attribute associated with the federal account attribute line.
• FromPeriodName: string
  Title: From Period

  Maximum Length: 15

  Name of the starting period associated with the federal account attribute line.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  The user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ToPeriodName: string
  Title: To Period

  Maximum Length: 15

  Name of the ending period associated with the federal account attribute line.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountAttributeLineId":{
            "title":"Account Attribute Line ID",
            "type":"integer",
            "description":"The unique identifier of the federal account attribute line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeValue":{
            "title":"Value",
            "maxLength":"255",
            "type":"string",
            "description":"Value of the federal attribute.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "FederalAttributeName"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FederalAttributeName":{
            "title":"Federal Attribute Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the federal attribute associated with the federal account attribute line.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "FederalAttributeId"
                ]
            },
            "x-queryable":true
        },
        "FromPeriodName":{
            "title":"From Period",
            "maxLength":"15",
            "type":"string",
            "description":"Name of the starting period associated with the federal account attribute line.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "FederalAttributeName"
                ]
            },
            "x-queryable":true
        },
        "ToPeriodName":{
            "title":"To Period",
            "maxLength":"15",
            "type":"string",
            "description":"Name of the ending period associated with the federal account attribute line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "FederalAttributeName"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "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."
        }
    }
}

Links

fedAccountAttributeLines

Operation: /fscmRestApi/resources/11.13.18.05/fedAccountAttributes/{AccountAttributeHeaderId}/child/fedAccountAttributeLines

Parameters:

• AccountAttributeHeaderId: $request.path.AccountAttributeHeaderId

The federal account attribute lines enable users to manage account attribute with lines.

Back to Top