Create locations for an analysis hierarchy
post
/fscmRestApi/resources/11.13.18.05/analysisHierarchies/{EisHierarchyId}/child/AnalysisHierarchyLocations
Request
Path Parameters
-
EisHierarchyId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Description: string
Maximum Length:
481
Description of the analysis hierarchy location. -
EisHierarchyId: integer
(int64)
Value that uniquely identifies the analysis hierarchy.
-
Location: string
Maximum Length:
60
Name of the analysis hierarchy location. -
LocationId: integer
(int64)
Value that uniquely identifies the analysis hierarchy location.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : analysisHierarchies-AnalysisHierarchyLocations-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the analysis hierarchy locations. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the analysis hierarchy locations. -
Description: string
Maximum Length:
481
Description of the analysis hierarchy location. -
EisHierarchyId: integer
(int64)
Value that uniquely identifies the analysis hierarchy.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the analysis hierarchy locations. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the analysis hierarchy locations. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Location: string
Maximum Length:
60
Name of the analysis hierarchy location. -
LocationId: integer
(int64)
Value that uniquely identifies the analysis hierarchy location.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to create locations for an analysis hierarchy.
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' "https://servername/fscmRestApi/resources/version/analysisHierarchies/EisHierarchyId/child/AnalysisHierarchyLocations"
For example:
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/analysisHierarchies/300100564971696/child/AnalysisHierarchyLocations"
Example Request Body
The following example includes the contents of the request body in JSON format:
{ "Location": "BR4" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "EisHierarchyId": 300100564971696, "LocationId": 16635, "Location": "BR4", "Description": "16635-BR4", "CreatedBy": "APS_ALL", "CreationDate": "2022-06-08T06:10:46+00:00", "LastUpdateDate": "2022-06-08T06:10:46.161+00:00", "LastUpdatedBy": "APS_ALL", "links": [ { "rel": "self", "href": "https://server/fscmRestApi/resources/version/analysisHierarchies/300100564971696/child/AnalysisHierarchyLocations/16635", "name": "AnalysisHierarchyLocations", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://server/fscmRestApi/resources/version/analysisHierarchies/300100564971696/child/AnalysisHierarchyLocations/16635", "name": "AnalysisHierarchyLocations", "kind": "item" }, { "rel": "parent", "href": "https://server/fscmRestApi/resources/version/analysisHierarchies/300100564971696", "name": "analysisHierarchies", "kind": "item" } ] }