Jump to

• Request
• Response
• Examples

Create a federal account symbol

post

/fscmRestApi/resources/11.13.18.05/fedAccountSymbols

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AgencyIdentifier(required): string
  Title: Agency Identifier

  Maximum Length: 3

  Agency identifier of the federal account symbol.
• AgencyType: string
  Title: Agency Type

  Agency type for the federal account symbol.
• AllowNonFederalException: string
  Title: Allow Non-Federal Exception

  Identifies that a Federal Account Symbol is exempt from requiring nonfederal trading partners to make advances for reimbursable work.
• fedAccountSymbolDFF: array fedAccountSymbolDFF
• FedAccountSymbolId: integer (int64)
  Title: Federal Account Symbol ID

  Unique code of federal account symbol.
• FederalAccountSymbolTitle(required): string
  Title: Federal Account Symbol

  Maximum Length: 240

  Title for the federal account symbol.
• MainAccountCode(required): string
  Title: Main Account Code

  Maximum Length: 4

  Main account code of the federal account symbol.

{
    "required":[
        "AgencyIdentifier",
        "FederalAccountSymbolTitle",
        "MainAccountCode"
    ],
    "type":"object",
    "properties":{
        "FedAccountSymbolId":{
            "title":"Federal Account Symbol ID",
            "type":"integer",
            "description":"Unique code of federal account symbol.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "FederalAccountSymbolTitle":{
            "title":"Federal Account Symbol",
            "maxLength":240,
            "type":"string",
            "description":"Title for the federal account symbol.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AgencyIdentifier":{
            "title":"Agency Identifier",
            "maxLength":3,
            "type":"string",
            "description":"Agency identifier of the federal account symbol.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "fedAccountSymbolDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/fedAccountSymbols-fedAccountSymbolDFF-item-post-request"
            }
        },
        "AgencyType":{
            "title":"Agency Type",
            "type":"string",
            "description":"Agency type for the federal account symbol.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LookupCode",
                    "Meaning"
                ]
            }
        },
        "MainAccountCode":{
            "title":"Main Account Code",
            "maxLength":4,
            "type":"string",
            "description":"Main account code of the federal account symbol.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AllowNonFederalException":{
            "title":"Allow Non-Federal Exception",
            "type":"string",
            "description":"Identifies that a Federal Account Symbol is exempt from requiring nonfederal trading partners to make advances for reimbursable work.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LookupType1",
                    "Meaning1"
                ]
            }
        }
    }
}

Nested Schema : fedAccountSymbolDFF

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/fedAccountSymbols-fedAccountSymbolDFF-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• FedAccountSymbolId: integer (int64)

{
    "type":"object",
    "properties":{
        "FedAccountSymbolId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "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":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "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(required):
  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(required):
  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 : fedAccountSymbols-item-response

Type: object

Show Source

• AgencyIdentifier: string
  Title: Agency Identifier

  Maximum Length: 3

  Agency identifier of the federal account symbol.
• AgencyType: string
  Title: Agency Type

  Agency type for the federal account symbol.
• AllowNonFederalException: string
  Title: Allow Non-Federal Exception

  Identifies that a Federal Account Symbol is exempt from requiring nonfederal trading partners to make advances for reimbursable work.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• fedAccountSymbolDFF: array fedAccountSymbolDFF
• FedAccountSymbolId: integer (int64)
  Title: Federal Account Symbol ID

  Unique code of federal account symbol.
• FederalAccountSymbolTitle: string
  Title: Federal Account Symbol

  Maximum Length: 240

  Title for the federal account symbol.
• 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.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The last user login that was used to update the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MainAccountCode: string
  Title: Main Account Code

  Maximum Length: 4

  Main account code of the federal account symbol.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "FedAccountSymbolId":{
            "title":"Federal Account Symbol ID",
            "type":"integer",
            "description":"Unique code of federal account symbol.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FederalAccountSymbolTitle":{
            "title":"Federal Account Symbol",
            "maxLength":240,
            "type":"string",
            "description":"Title for the federal account symbol.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "AgencyIdentifier":{
            "title":"Agency Identifier",
            "maxLength":3,
            "type":"string",
            "description":"Agency identifier of the federal account symbol.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "fedAccountSymbolDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/fedAccountSymbols-fedAccountSymbolDFF-item-response"
            }
        },
        "AgencyType":{
            "title":"Agency Type",
            "type":"string",
            "description":"Agency type for the federal account symbol.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LookupCode",
                    "Meaning"
                ]
            },
            "x-queryable":true
        },
        "AllowNonFederalException":{
            "title":"Allow Non-Federal Exception",
            "type":"string",
            "description":"Identifies that a Federal Account Symbol is exempt from requiring nonfederal trading partners to make advances for reimbursable work.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LookupType1",
                    "Meaning1"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MainAccountCode":{
            "title":"Main Account Code",
            "maxLength":4,
            "type":"string",
            "description":"Main account code of the federal account symbol.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The last user login that was used to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : fedAccountSymbolDFF

Type: array

Show Source

• Array of: object fedAccountSymbols-fedAccountSymbolDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/fedAccountSymbols-fedAccountSymbolDFF-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 : fedAccountSymbols-fedAccountSymbolDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• FedAccountSymbolId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "FedAccountSymbolId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "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":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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

fedAccountSymbolDFF

Operation: /fscmRestApi/resources/11.13.18.05/fedAccountSymbols/{FedAccountSymbolId}/child/fedAccountSymbolDFF

Parameters:

• FedAccountSymbolId: $request.path.FedAccountSymbolId

Back to Top

Examples

The following example shows how to create an expense report by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAccountSymbols

Example Request Payload

The following example shows the contents of the request body in JSON format:

{
    "AgencyType": "Trading Partner",
    "FederalAccountSymbolTitle": "Test Account Symbol",
    "AgencyIdentifier": "990",
    "MainAccountCode": "4442",
    "AllowNonFederalException": "Yes"
}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "FedAccountSymbolId": 300100184574436,
    "AgencyType": "Trading Partner",
    "CreatedBy": "FIN_USER1",
    "FederalAccountSymbolTitle": "Test Account Symbol",
    "AgencyIdentifier": "990",
    "MainAccountCode": "4442",
    "AllowNonFederalException": "Yes",
    "CreationDate": "2020-05-21T16:53:11.010+00:00",
    "LastUpdateLogin": "A61339A645FB440DE053D38CB00AC7D7",
    "LastUpdatedBy": "FIN_USER1",
    "LastUpdateDate": "2020-05-21T16:53:11.033+00:00",
    "links": [
        {
            "rel": "self",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAccountSymbols/300100184574436",
            "name": "fedAccountSymbols",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAccountSymbols/300100184574436",
            "name": "fedAccountSymbols",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAccountSymbols/300100184574436/child/fedAccountSymbolDFF",
            "name": "fedAccountSymbolDFF",
            "kind": "collection"
        }
    ]
}

Back to Top