Jump to

• Request
• Response
• Examples

Create a rule detail

post

/fscmRestApi/resources/11.13.18.05/costAccountingOverheadRules/{RuleId}/child/OverheadRuleDetails

Request

Path Parameters

• RuleId(required): integer(int64)
  Value that uniquely identifies the overhead rule. The system creates this value.

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  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

• EndDate: string (date)
  Title: End Date

  Date when this revision of the overhead rule becomes inactive. The transactions till this date use the overhead rate when applicable.
• FromPeriod: string
  Title: From Period

  Cost book period from when the overhead rate is applicable.
• Rate: number
  Title: Rate

  Rate to use for calculation of overhead. It's either a number or a percentage depending on the cost basis defined for this overhead rule.
• StartDate: string (date)
  Title: Start Date

  Date when this revision of the overhead rule becomes active. The transactions on or after this date use the overhead rate when applicable.
• ToPeriod: string
  Title: To Period

  Cost book period till when the overhead rate is applicable.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when this revision of the overhead rule becomes active. The transactions on or after this date use the overhead rate when applicable.",
            "format":"date",
            "nullable":false
        },
        "ToPeriod":{
            "title":"To Period",
            "type":"string",
            "description":"Cost book period till when the overhead rate is applicable.",
            "nullable":true,
            "x-hints":{
                "sortable":false
            }
        },
        "FromPeriod":{
            "title":"From Period",
            "type":"string",
            "description":"Cost book period from when the overhead rate is applicable.",
            "nullable":true,
            "x-hints":{
                "sortable":false
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when this revision of the overhead rule becomes inactive. The transactions till this date use the overhead rate when applicable.",
            "format":"date",
            "nullable":false
        },
        "Rate":{
            "title":"Rate",
            "type":"number",
            "description":"Rate to use for calculation of overhead. It's either a number or a percentage depending on the cost basis defined for this overhead rule.",
            "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 : costAccountingOverheadRules-OverheadRuleDetails-item-response

Type: object

Show Source

• CostBook: string
  Read Only: true

  Cost book to which the overhead rule applies.
• CostOrganizationName: string
  Read Only: true

  Name of the cost organization to which the overhead rule applies.
• EndDate: string (date)
  Title: End Date

  Date when this revision of the overhead rule becomes inactive. The transactions till this date use the overhead rate when applicable.
• FromPeriod: string
  Title: From Period

  Cost book period from when the overhead rate is applicable.
• FromPeriodStatus: string
  Read Only: true

  Indicates the status of the period from when the overhead rate is defined.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProcessedFlagMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Status of the rule revision that indicates if it's used by the cost processor for absorption of the overheads.
• Rate: number
  Title: Rate

  Rate to use for calculation of overhead. It's either a number or a percentage depending on the cost basis defined for this overhead rule.
• RevisionNumber: integer
  Title: Revision Number

  Read Only: true

  Revision number of the rule detail. The system generates this value.
• RuleDetailId: integer (int64)
  Title: Rule Detail ID

  Read Only: true

  Value that uniquely identifies the overhead rule detail. The system creates this value.
• RuleId: integer (int64)
  Title: Rule ID

  Read Only: true

  Value that uniquely identifies the overhead rule against which this rule detail is created.
• RuleName: string
  Read Only: true

  Name of the rule that the user specifies. The rule name must be unique.
• StartDate: string (date)
  Title: Start Date

  Date when this revision of the overhead rule becomes active. The transactions on or after this date use the overhead rate when applicable.
• ToPeriod: string
  Title: To Period

  Cost book period till when the overhead rate is applicable.

{
    "type":"object",
    "properties":{
        "ToPeriod":{
            "title":"To Period",
            "type":"string",
            "description":"Cost book period till when the overhead rate is applicable.",
            "nullable":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "Rate":{
            "title":"Rate",
            "type":"number",
            "description":"Rate to use for calculation of overhead. It's either a number or a percentage depending on the cost basis defined for this overhead rule.",
            "nullable":false,
            "x-queryable":true
        },
        "RuleId":{
            "title":"Rule ID",
            "type":"integer",
            "description":"Value that uniquely identifies the overhead rule against which this rule detail is created.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FromPeriodStatus":{
            "type":"string",
            "description":"Indicates the status of the period from when the overhead rate is defined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ProcessedFlagMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Status of the rule revision that indicates if it's used by the cost processor for absorption of the overheads.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FromPeriod":{
            "title":"From Period",
            "type":"string",
            "description":"Cost book period from when the overhead rate is applicable.",
            "nullable":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "RevisionNumber":{
            "title":"Revision Number",
            "type":"integer",
            "description":"Revision number of the rule detail. The system generates this value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when this revision of the overhead rule becomes inactive. The transactions till this date use the overhead rate when applicable.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "RuleDetailId":{
            "title":"Rule Detail ID",
            "type":"integer",
            "description":"Value that uniquely identifies the overhead rule detail. The system creates this value.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when this revision of the overhead rule becomes active. The transactions on or after this date use the overhead rate when applicable.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CostOrganizationName":{
            "type":"string",
            "description":"Name of the cost organization to which the overhead rule applies.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostBook":{
            "type":"string",
            "description":"Cost book to which the overhead rule applies.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleName":{
            "type":"string",
            "description":"Name of the rule that the user specifies. The rule name must be unique.",
            "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

This example describes how to create one overhead rule detail.

Example 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' 
servername/fscmRestApi/resources/version/costAccountingOverheadRules/RuleId/child/OverheadRuleDetail"

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 creates.

{
  "StartDate" : "2019-01-02",
  "Rate" : 20
}

Example 1 Response Body

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

{
   "RuleId": 300100111253919,
   "RuleDetailId": 300100111253922,
   "RevisionNumber": 2,
   "StartDate": "2019-01-02",
   "EndDate": "4712-12-31",
   "Rate": 20
}

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 creates.

{
    "FromPeriod": "12-21",
    "ToPeriod": "12-21",
    "Rate": 20
}

Example 2 Response Body

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

{
    "RuleId": 300100549680658,
    "RuleDetailId": 300100549689814,
    "RevisionNumber": 2,
    "StartDate": "2021-12-01",
    "EndDate": "2021-12-31",
    "Rate": 20,
    "FromPeriod": "12-21",
    "ToPeriod": "12-21",
    "FromPeriodStatus": "Never opened",
    "RuleName": "Demo Rule 1",
    "CostOrganizationName": "Auto1-CO",
    "CostBook": "PAC BOOK 1",
    "ProcessedFlagMeaning": null,
    "links": [
        {
            "rel": "self",
            "href": "https://server/fscmRestApi/resources/version/costAccountingOverheadRules/300100549680658/child/OverheadRuleDetails/300100549689814",
            "name": "OverheadRuleDetails",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://server/fscmRestApi/resources/version/costAccountingOverheadRules/300100549680658/child/OverheadRuleDetails/300100549689814",
            "name": "OverheadRuleDetails",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://server/fscmRestApi/resources/version/costAccountingOverheadRules/300100549680658",
            "name": "costAccountingOverheadRules",
            "kind": "item"
        }
    ]
}

Back to Top