Jump to

• Request
• Response
• Examples

Get one rule detail

get

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

Request

Path Parameters

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

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 is 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 is 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 get one overhead rule detail.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/costAccountingOverheadRules/RuleId/child/OverheadRuleDetails/RuleDetailId"

For example, the following command gets overhead rule detail where the rule identifier is 300100111253919 and rule detail identifier is 300100111253920:

curl -u username:password "https://servername/fscmRestApi/resources/version/costAccountingOverheadRules/300100111253919/child/OverheadRuleDetails/300100111253920"

Example Response Body

The following shows an example of the response body in JSON format.

{
    "RuleId" : 300100111253919,
    "RuleDetailId" : 300100111253920,
    "RevisionNumber" : 1,
    "StartDate" : "2017-01-01",
    "EndDate" : "4712-12-31",
    "Rate" : 10
}

Back to Top