Jump to

• Request
• Response
• Examples

Create a CTA FBWT account definition

post

/fscmRestApi/resources/11.13.18.05/fedCTAFBWTAccountDefinitions

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

• AccountDescription: string
  Title: Account Description

  Maximum Length: 255

  Description of the CTA FBWT account.
• AgencyLocationCode: string
  Title: Agency Location Code

  Maximum Length: 255

  Code that indicates the agency location.
• ALCName: string
  Title: ALC Name

  Maximum Length: 255

  Agency location code name.
• BETCType: string
  Title: BETC Type

  Maximum Length: 255

  BETC type.
• CTAFBWTAccountDefId: integer (int64)
  The unique identifier of the CTA FBWT account definition.
• FederalGroup: string
  Title: Federal Group

  Maximum Length: 80

  Name of the federal group.
• NaturalAccountSegment: string
  Title: Account

  Maximum Length: 25

  Value of the natural account segment.

{
    "type":"object",
    "properties":{
        "AccountDescription":{
            "title":"Account Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the CTA FBWT account.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Description",
                    "Value",
                    "ValueSetId"
                ]
            }
        },
        "NaturalAccountSegment":{
            "title":"Account",
            "maxLength":"25",
            "type":"string",
            "description":"Value of the natural account segment.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "FederalGroup",
                    "ValueSetId"
                ]
            }
        },
        "CTAFBWTAccountDefId":{
            "type":"integer",
            "description":"The unique identifier of the CTA FBWT account definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "AgencyLocationCode":{
            "title":"Agency Location Code",
            "maxLength":"255",
            "type":"string",
            "description":"Code that indicates the agency location.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "AgencyLocationCode1"
                ]
            }
        },
        "BETCType":{
            "title":"BETC Type",
            "maxLength":"255",
            "type":"string",
            "description":"BETC type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LookupCode"
                ]
            }
        },
        "ALCName":{
            "title":"ALC Name",
            "maxLength":"255",
            "type":"string",
            "description":"Agency location code name.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AgencyLocationName"
                ]
            }
        },
        "FederalGroup":{
            "title":"Federal Group",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the federal group.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "GroupName",
                    "LedgerGroupId1"
                ]
            }
        }
    }
}

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

Type: object

Show Source

• AccountDescription: string
  Title: Account Description

  Maximum Length: 255

  Description of the CTA FBWT account.
• AgencyLocationCode: string
  Title: Agency Location Code

  Maximum Length: 255

  Code that indicates the agency location.
• ALCName: string
  Title: ALC Name

  Maximum Length: 255

  Agency location code name.
• BETCType: string
  Title: BETC Type

  Maximum Length: 255

  BETC type.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Date when the record was created.
• CTAFBWTAccountDefId: integer (int64)
  The unique identifier of the CTA FBWT account definition.
• FederalGroup: string
  Title: Federal Group

  Maximum Length: 80

  Name of the federal group.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

  Date when the user who last updated the record logged in.
• links: array Links
  Title: Links

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

  Maximum Length: 25

  Value of the natural account segment.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountDescription":{
            "title":"Account Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the CTA FBWT account.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Description",
                    "Value",
                    "ValueSetId"
                ]
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CTAFBWTAccountDefId":{
            "type":"integer",
            "description":"The unique identifier of the CTA FBWT account definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BETCType":{
            "title":"BETC Type",
            "maxLength":"255",
            "type":"string",
            "description":"BETC type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LookupCode"
                ]
            },
            "x-queryable":true
        },
        "FederalGroup":{
            "title":"Federal Group",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the federal group.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "GroupName",
                    "LedgerGroupId1"
                ]
            },
            "x-queryable":true
        },
        "NaturalAccountSegment":{
            "title":"Account",
            "maxLength":"25",
            "type":"string",
            "description":"Value of the natural account segment.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "FederalGroup",
                    "ValueSetId"
                ]
            },
            "x-queryable":true
        },
        "AgencyLocationCode":{
            "title":"Agency Location Code",
            "maxLength":"255",
            "type":"string",
            "description":"Code that indicates the agency location.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "AgencyLocationCode1"
                ]
            },
            "x-queryable":true
        },
        "ALCName":{
            "title":"ALC Name",
            "maxLength":"255",
            "type":"string",
            "description":"Agency location code name.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AgencyLocationName"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Date when the user who last updated the record logged in.",
            "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

Examples

You can use the POST action in the Federal CTA FBWT Account Definitions REST API to create Federal Group, Natural Account Segment, BETCType, and Agency Location Code.

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/fedCTAFBWTAccountDefinitions

Example Request Payload

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

{   
    "FederalGroup" : " US Federal1 US Group",
    "NaturalAccountSegment" : "101000",
    "BETCType" : "Collection",
    "AgencyLocationCode" : "99990055"
}

Example Response Body

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

{
  "CTAFBWTAccountDefId" : 300100573770410,
  "FederalGroup" : " US Federal1 US Group",
  "NaturalAccountSegment" : "101000",
  "AccountDescription" : null,
  "BETCType" : "Collection",
  "AgencyLocationCode" : "99990055",
  "ALCName" : "Federal Payments ALC",
  "CreationDate" : "2023-03-20T10:05:02+00:00",
  "CreatedBy" : "FEDBUYER",
  "LastUpdateDate" : "2023-03-20T10:05:02.044+00:00",
  "LastUpdatedBy" : "FEDBUYER",
  "LastUpdateLogin" : null,
  "links" : [ {
    "rel" : "self",
    "href" : "https://fuscdrmsmc58-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.18.05/fedCTAFBWTAccountDefinitions/300100573770410",
    "name" : "fedCTAFBWTAccountDefinitions",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://fuscdrmsmc58-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.18.05/fedCTAFBWTAccountDefinitions/300100573770410",
    "name" : "fedCTAFBWTAccountDefinitions",
    "kind" : "item"
  } ]
}

Back to Top