Jump to

• Request
• Response
• Examples

Create a federal group

post

/fscmRestApi/resources/11.13.18.05/fedGroups

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

• Description(required): string
  Title: Description

  Maximum Length: 100

  Description of the federal group.
• FederalGroup(required): string
  Title: Federal Group Name

  Maximum Length: 30

  Name of the federal group.
• fedGroupBudgetLevels: array Federal Group Budget Levels
  Title: Federal Group Budget Levels

  The group budget levels resource is used to query, create, and update group budget levels.
• FreezeBudgetLevel: string
  Title: Freeze Budget Levels

  Freeze budget level flag of the federal group.
• LedgerGroupId: integer (int64)
  Title: Federal Group ID

  The unique identifier of the ledger group associated with the federal group.
• NaturalAccountValueSet: string
  Title: Natural Account Value Set

  Natural account value set of the federal group.

{
    "required":[
        "Description",
        "FederalGroup"
    ],
    "type":"object",
    "properties":{
        "NaturalAccountValueSet":{
            "title":"Natural Account Value Set",
            "type":"string",
            "description":"Natural account value set of the federal group.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ValueSetCode",
                    "ValueSetId"
                ]
            }
        },
        "FreezeBudgetLevel":{
            "title":"Freeze Budget Levels",
            "type":"string",
            "description":"Freeze budget level flag of the federal group.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LookupCode",
                    "Meaning"
                ]
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"Description of the federal group.",
            "nullable":false
        },
        "LedgerGroupId":{
            "title":"Federal Group ID",
            "type":"integer",
            "description":"The unique identifier of the ledger group associated with the federal group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "FederalGroup":{
            "title":"Federal Group Name",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the federal group.",
            "nullable":false
        },
        "fedGroupBudgetLevels":{
            "title":"Federal Group Budget Levels",
            "type":"array",
            "description":"The group budget levels resource is used to query, create, and update group budget levels.",
            "items":{
                "$ref":"#/components/schemas/fedGroups-fedGroupBudgetLevels-item-post-request"
            }
        }
    }
}

Nested Schema : Federal Group Budget Levels

Type: array

Title: Federal Group Budget Levels

The group budget levels resource is used to query, create, and update group budget levels.

Show Source

• Array of: object fedGroups-fedGroupBudgetLevels-item-post-request

{
    "title":"Federal Group Budget Levels",
    "type":"array",
    "description":"The group budget levels resource is used to query, create, and update group budget levels.",
    "items":{
        "$ref":"#/components/schemas/fedGroups-fedGroupBudgetLevels-item-post-request"
    }
}

Nested Schema : fedGroups-fedGroupBudgetLevels-item-post-request

Type: object

Show Source

• BudgetLevelName: string
  Title: Budget Levels

  Maximum Length: 30

  Name of the federal group budget level.
• BudgetSequenceNumber: integer (int64)
  Title: Budget Level Sequence

  Budget sequence number of the federal group budget level.
• Description: string
  Title: Description

  Maximum Length: 100

  Description of the federal group budget level.
• GroupBeLevelId: integer (int64)
  Title: Federal Group Level ID

  The unique identifier of the group BE level associated with the federal group budget level.

{
    "type":"object",
    "properties":{
        "BudgetSequenceNumber":{
            "title":"Budget Level Sequence",
            "type":"integer",
            "description":"Budget sequence number of the federal group budget level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"Description of the federal group budget level.",
            "nullable":false
        },
        "GroupBeLevelId":{
            "title":"Federal Group Level ID",
            "type":"integer",
            "description":"The unique identifier of the group BE level associated with the federal group budget level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "BudgetLevelName":{
            "title":"Budget Levels",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the federal group budget level.",
            "nullable":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 : fedGroups-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  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.
• Description: string
  Title: Description

  Maximum Length: 100

  Description of the federal group.
• FederalGroup: string
  Title: Federal Group Name

  Maximum Length: 30

  Name of the federal group.
• fedGroupBudgetLevels: array Federal Group Budget Levels
  Title: Federal Group Budget Levels

  The group budget levels resource is used to query, create, and update group budget levels.
• FreezeBudgetLevel: string
  Title: Freeze Budget Levels

  Freeze budget level flag of the federal group.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  Date when the user last logged in.
• LedgerGroupId: integer (int64)
  Title: Federal Group ID

  The unique identifier of the ledger group associated with the federal group.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NaturalAccountValueSet: string
  Title: Natural Account Value Set

  Natural account value set of the federal group.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NaturalAccountValueSet":{
            "title":"Natural Account Value Set",
            "type":"string",
            "description":"Natural account value set of the federal group.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ValueSetCode",
                    "ValueSetId"
                ]
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"Description of the federal group.",
            "nullable":false,
            "x-queryable":true
        },
        "FreezeBudgetLevel":{
            "title":"Freeze Budget Levels",
            "type":"string",
            "description":"Freeze budget level flag of the federal group.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LookupCode",
                    "Meaning"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LedgerGroupId":{
            "title":"Federal Group ID",
            "type":"integer",
            "description":"The unique identifier of the ledger group associated with the federal group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FederalGroup":{
            "title":"Federal Group Name",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the federal group.",
            "nullable":false,
            "x-queryable":true
        },
        "fedGroupBudgetLevels":{
            "title":"Federal Group Budget Levels",
            "type":"array",
            "description":"The group budget levels resource is used to query, create, and update group budget levels.",
            "items":{
                "$ref":"#/components/schemas/fedGroups-fedGroupBudgetLevels-item-response"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"Date when the user last logged in.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Federal Group Budget Levels

Type: array

Title: Federal Group Budget Levels

The group budget levels resource is used to query, create, and update group budget levels.

Show Source

• Array of: object fedGroups-fedGroupBudgetLevels-item-response

{
    "title":"Federal Group Budget Levels",
    "type":"array",
    "description":"The group budget levels resource is used to query, create, and update group budget levels.",
    "items":{
        "$ref":"#/components/schemas/fedGroups-fedGroupBudgetLevels-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 : fedGroups-fedGroupBudgetLevels-item-response

Type: object

Show Source

• BudgetLevelName: string
  Title: Budget Levels

  Maximum Length: 30

  Name of the federal group budget level.
• BudgetSequenceNumber: integer (int64)
  Title: Budget Level Sequence

  Budget sequence number of the federal group budget level.
• CreatedBy: string
  Title: Created By

  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.
• Description: string
  Title: Description

  Maximum Length: 100

  Description of the federal group budget level.
• GroupBeLevelId: integer (int64)
  Title: Federal Group Level ID

  The unique identifier of the group BE level associated with the federal group budget level.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"Description of the federal group budget level.",
            "nullable":false,
            "x-queryable":true
        },
        "BudgetLevelName":{
            "title":"Budget Levels",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the federal group budget level.",
            "nullable":false,
            "x-queryable":true
        },
        "BudgetSequenceNumber":{
            "title":"Budget Level Sequence",
            "type":"integer",
            "description":"Budget sequence number of the federal group budget level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GroupBeLevelId":{
            "title":"Federal Group Level ID",
            "type":"integer",
            "description":"The unique identifier of the group BE level associated with the federal group budget level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "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."
        }
    }
}

Links

fedGroupBudgetLevels

Operation: /fscmRestApi/resources/11.13.18.05/fedGroups/{LedgerGroupId}/child/fedGroupBudgetLevels

Parameters:

• LedgerGroupId: $request.path.LedgerGroupId

The group budget levels resource is used to query, create, and update group budget levels.

Back to Top

Examples

The following example shows how to create a federal group 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/fedGroups

Example Request Body

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

{
    "FederalGroup": "Federal Group Name Test",
    "NaturalAccountValueSet": "Operations Account",
    "Description":"Federal Group Name Test Description",                
    "FreezeBudgetLevel": "No",
    "fedGroupBudgetLevels":
    [
        {
            "BudgetSequenceNumber": 10,
            "BudgetLevelName": "Budget Level1",
            "Description": "Budget Level1 Description"
        },
        {
            "BudgetSequenceNumber": 20,
            "BudgetLevelName": "Budget Level2",
            "Description": "Budget Level2 Description"
        }
    ]
}

Example Response Body

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

{
    "LedgerGroupId": 300100544475189,
    "FederalGroup": "Federal Group Name Test",
    "Description": "Federal Group Name Test Description",
    "NaturalAccountValueSet": "Operations Account",
    "FreezeBudgetLevel": "No",
    "CreationDate": "2021-07-01T10:06:25+00:00",
    "CreatedBy": "FEDERAL",
    "LastUpdateDate": "2021-07-01T10:06:28.424+00:00",
    "LastUpdatedBy": "FEDERAL",
    "LastUpdateLogin": "C5FB3C2EB813CC2EE0538C96F40ADBC0",
    "fedGroupBudgetLevels": {
    "items": [
        {
            "GroupBeLevelId": 300100544475190,
            "BudgetSequenceNumber": 10,
            "BudgetLevelName": "Budget Level1",
            "Description": "Budget Level1 Description",
            "CreationDate": "2021-07-01T10:06:28.371+00:00",
            "CreatedBy": "FEDERAL",
            "LastUpdateDate": "2021-07-01T10:06:28.440+00:00",
            "LastUpdatedBy": "FEDERAL",
            "LastUpdateLogin": "C5FB3C2EB813CC2EE0538C96F40ADBC0",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedGroups/300100544475189/child/fedGroupBudgetLevels/300100544475190",
                    "name": "fedGroupBudgetLevels",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                        }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedGroups/300100544475189/child/fedGroupBudgetLevels/300100544475190",
                    "name": "fedGroupBudgetLevels",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedGroups/300100544475189",
                    "name": "fedGroups",
                    "kind": "item"
                }
            ]
        },
        {
            "GroupBeLevelId": 300100544475191,
            "BudgetSequenceNumber": 20,
            "BudgetLevelName": "Budget Level2",
            "Description": "Budget Level2 Description",
            "CreationDate": "2021-07-01T10:06:28.400+00:00",
            "CreatedBy": "FEDERAL",
            "LastUpdateDate": "2021-07-01T10:06:28.486+00:00",
            "LastUpdatedBy": "FEDERAL",
            "LastUpdateLogin": "C5FB3C2EB813CC2EE0538C96F40ADBC0",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedGroups/300100544475189/child/fedGroupBudgetLevels/300100544475191",
                    "name": "fedGroupBudgetLevels",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                        }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedGroups/300100544475189/child/fedGroupBudgetLevels/300100544475191",
                    "name": "fedGroupBudgetLevels",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedGroups/300100544475189",
                    "name": "fedGroups",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 2,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedGroups/300100544475189/child/fedGroupBudgetLevels",
            "name": "fedGroupBudgetLevels",
            "kind": "collection"
        }
    ]
    },
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedGroups/300100544475189",
            "name": "fedGroups",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedGroups/300100544475189",
            "name": "fedGroups",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedGroups/300100544475189/child/fedGroupBudgetLevels",
            "name": "fedGroupBudgetLevels",
            "kind": "collection"
        }
    ]
}

Back to Top