Jump to

• Request
• Response
• Examples

Create

post

/fscmRestApi/resources/11.13.18.05/costRollupGroups

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

• costRollupGroupDetails: array Cost Rollup Group Details
  Title: Cost Rollup Group Details

  The Cost Rollup Group Details resource allows users to manage a cost rollup group by adding, modifying, and deleting combinations of cost organizations and books within the group.
• RollupGroupDescription: string
  Title: Description

  Maximum Length: 240
• RollupGroupId: integer (int64)
  Title: Cost Rollup Group ID
• RollupGroupName(required): string
  Title: Name

  Maximum Length: 80

{
    "required":[
        "RollupGroupName"
    ],
    "type":"object",
    "properties":{
        "RollupGroupId":{
            "title":"Cost Rollup Group ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "costRollupGroupDetails":{
            "title":"Cost Rollup Group Details",
            "type":"array",
            "description":"The Cost Rollup Group Details resource allows users to manage a cost rollup group by adding, modifying, and deleting combinations of cost organizations and books within the group.",
            "items":{
                "$ref":"#/components/schemas/costRollupGroups-costRollupGroupDetails-item-post-request"
            }
        },
        "RollupGroupName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "nullable":false
        },
        "RollupGroupDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "nullable":true
        }
    }
}

Nested Schema : Cost Rollup Group Details

Type: array

Title: Cost Rollup Group Details

The Cost Rollup Group Details resource allows users to manage a cost rollup group by adding, modifying, and deleting combinations of cost organizations and books within the group.

Show Source

• Array of: object costRollupGroups-costRollupGroupDetails-item-post-request

{
    "title":"Cost Rollup Group Details",
    "type":"array",
    "description":"The Cost Rollup Group Details resource allows users to manage a cost rollup group by adding, modifying, and deleting combinations of cost organizations and books within the group.",
    "items":{
        "$ref":"#/components/schemas/costRollupGroups-costRollupGroupDetails-item-post-request"
    }
}

Nested Schema : costRollupGroups-costRollupGroupDetails-item-post-request

Type: object

Show Source

• CostBook: string
  Title: Cost Book

  Maximum Length: 30

  Name of the cost book for the rollup group. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Cost Books task.
• CostBookId: integer (int64)
  Title: Cost Book ID

  Value that uniquely identifies the cost book included in the rollup group.
• CostOrganizationId: integer (int64)
  Title: Cost Organization ID

  Value that uniquely identifies the cost organization included in the rollup group.
• CostOrganizationName: string
  Title: Cost Organization Name

  Maximum Length: 240

  Name of the cost organization for the rollup group. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Cost Organizations task.
• RollupGroupDetailId: integer (int64)
  Title: Cost Rollup Group Detail ID

  Value that uniquely identifies the rollup group details. The application generates this value.
• RollupGroupId: integer (int64)
  Title: Cost Rollup Group ID

  Value that uniquely identifies the rollup group for the rollup group details.

{
    "type":"object",
    "properties":{
        "CostOrganizationName":{
            "title":"Cost Organization Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the cost organization for the rollup group. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Cost Organizations task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RollupGroupId":{
            "title":"Cost Rollup Group ID",
            "type":"integer",
            "description":"Value that uniquely identifies the rollup group for the rollup group details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CostBook":{
            "title":"Cost Book",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the cost book for the rollup group. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Cost Books task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CostOrganizationId":{
            "title":"Cost Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cost organization included in the rollup group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RollupGroupDetailId":{
            "title":"Cost Rollup Group Detail ID",
            "type":"integer",
            "description":"Value that uniquely identifies the rollup group details. The application generates this value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CostBookId":{
            "title":"Cost Book ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cost book included in the rollup group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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

Type: object

Show Source

• costRollupGroupDetails: array Cost Rollup Group Details
  Title: Cost Rollup Group Details

  The Cost Rollup Group Details resource allows users to manage a cost rollup group by adding, modifying, and deleting combinations of cost organizations and books within the group.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RollupGroupDescription: string
  Title: Description

  Maximum Length: 240
• RollupGroupId: integer (int64)
  Title: Cost Rollup Group ID
• RollupGroupName: string
  Title: Name

  Maximum Length: 80

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupGroupId":{
            "title":"Cost Rollup Group ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "costRollupGroupDetails":{
            "title":"Cost Rollup Group Details",
            "type":"array",
            "description":"The Cost Rollup Group Details resource allows users to manage a cost rollup group by adding, modifying, and deleting combinations of cost organizations and books within the group.",
            "items":{
                "$ref":"#/components/schemas/costRollupGroups-costRollupGroupDetails-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RollupGroupName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "RollupGroupDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Cost Rollup Group Details

Type: array

Title: Cost Rollup Group Details

The Cost Rollup Group Details resource allows users to manage a cost rollup group by adding, modifying, and deleting combinations of cost organizations and books within the group.

Show Source

• Array of: object costRollupGroups-costRollupGroupDetails-item-response

{
    "title":"Cost Rollup Group Details",
    "type":"array",
    "description":"The Cost Rollup Group Details resource allows users to manage a cost rollup group by adding, modifying, and deleting combinations of cost organizations and books within the group.",
    "items":{
        "$ref":"#/components/schemas/costRollupGroups-costRollupGroupDetails-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 : costRollupGroups-costRollupGroupDetails-item-response

Type: object

Show Source

• CostBook: string
  Title: Cost Book

  Maximum Length: 30

  Name of the cost book for the rollup group. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Cost Books task.
• CostBookId: integer (int64)
  Title: Cost Book ID

  Value that uniquely identifies the cost book included in the rollup group.
• CostOrganizationId: integer (int64)
  Title: Cost Organization ID

  Value that uniquely identifies the cost organization included in the rollup group.
• CostOrganizationName: string
  Title: Cost Organization Name

  Maximum Length: 240

  Name of the cost organization for the rollup group. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Cost Organizations task.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Date on which the rollup group detail record was created.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date on which the rollup group detail record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the rollup group detail record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RollupGroupDetailId: integer (int64)
  Title: Cost Rollup Group Detail ID

  Value that uniquely identifies the rollup group details. The application generates this value.
• RollupGroupId: integer (int64)
  Title: Cost Rollup Group ID

  Value that uniquely identifies the rollup group for the rollup group details.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the rollup group detail record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date on which the rollup group detail record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CostOrganizationName":{
            "title":"Cost Organization Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the cost organization for the rollup group. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Cost Organizations task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the rollup group detail record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupGroupId":{
            "title":"Cost Rollup Group ID",
            "type":"integer",
            "description":"Value that uniquely identifies the rollup group for the rollup group details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CostBook":{
            "title":"Cost Book",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the cost book for the rollup group. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Cost Books task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostOrganizationId":{
            "title":"Cost Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cost organization included in the rollup group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RollupGroupDetailId":{
            "title":"Cost Rollup Group Detail ID",
            "type":"integer",
            "description":"Value that uniquely identifies the rollup group details. The application generates this value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "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"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date on which the rollup group detail record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CostBookId":{
            "title":"Cost Book ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cost book included in the rollup group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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

costRollupGroupDetails

Operation: /fscmRestApi/resources/11.13.18.05/costRollupGroups/{RollupGroupId}/child/costRollupGroupDetails

Parameters:

• RollupGroupId: $request.path.RollupGroupId

The Cost Rollup Group Details resource allows users to manage a cost rollup group by adding, modifying, and deleting combinations of cost organizations and books within the group.

Back to Top

Examples

These examples describe how to create cost rollup groups.

Example 1 cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/costRollupGroups"

Example 1 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
    "RollupGroupDescription": "Test RG Desc - 999",
    "RollupGroupName": "Test RG - 999",
    "costRollupGroupDetails": [
        {
            "CostBook": "ZCST-Dallas",
            "CostOrganizationName": "ZCST-Dallas"
        },
        {
            "CostBook": "404-CB",
            "CostOrganizationName": "404-CO"
        }
    ]
}

Example 1 Response Body

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

{
           "RollupGroupDescription": "Test RG Desc - 999",
    "RollupGroupName": "Test RG - 999",
            "LastUsedDate": null,
            "CreatedBy": "COST_ACCT_ALL_COST_ORGS",
            "CreationDate": "2023-03-21T03:30:58.765+00:00",
            "LastUpdatedBy": "COST_ACCT_ALL_COST_ORGS",
            "LastUpdateDate": "2023-03-21T03:30:58.766+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "http://servername/fscmRestApi/resources/version/costRollupGroups/300100573549594",
                    "name": "costRollupGroups",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "http://servername/fscmRestApi/resources/version/costRollupGroups/300100573549594",
                    "name": "transferChargeRules",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "http://servername/fscmRestApi/resources/version/costRollupGroups/300100573549594/child/costRollupGroupDetails",
                    "name": "costRollupGroupDetails",
                    "kind": "collection"
                }
            ]
        }

Example 2 cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/costRollupGroups/300100573549594"

Example 2 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

 {
            "CostBook": "ZCST-Seattle",
            "CostOrganizationName": "ZCST-Seattle"
 }

Example 2 Response Body

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

"costRollupGroupDetails": [
        {
            "CostBook": "ZCST-Dallas",
            "CostOrganizationName": "ZCST-Dallas"
        },
        {
            "CostBook": "404-CB",
            "CostOrganizationName": "404-CO"
        }, {
            "CostBook": "ZCST-Seattle",
            "CostOrganizationName": "ZCST-Seattle"
 }
    ]

Back to Top