Create analysis hierarchies
/fscmRestApi/resources/11.13.18.05/analysisHierarchies
Request
-
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.
- application/json
object
-
AnalysisHierarchyLocations: array
Analysis Hierarchy Locations
Title:
Analysis Hierarchy Locations
The Analysis Hierarchy Locations resource manages all locations within the analysis hierarchy. -
EisHierarchyId: integer
(int64)
Value that uniquely identifies the analysis hierarchy.
-
HierarchyDescription: string
Maximum Length:
240
Description of the analysis hierarchy. -
HierarchyName(required): string
Maximum Length:
120
Name of the analysis hierarchy. -
LastProcessId: integer
(int64)
Value that uniquely identifies the last create analysis hierarchy process.
-
LastRunDate: string
(date-time)
Date when the user most recently ran the create analysis hierarchy process.
-
ProcessAction: string
Maximum Length:
255
Name of the action to run the create analysis hierarchy process. -
SourceSystem: string
Maximum Length:
30
Name of the source application. -
SourceSystemId(required): integer
(int64)
Value that uniquely identifies the source application.
-
Status: integer
(int32)
Status of the create analysis hierarchy process.
array
Analysis Hierarchy Locations
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
- application/json
Default Response
-
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.
object
-
AnalysisHierarchyLocations: array
Analysis Hierarchy Locations
Title:
Analysis Hierarchy Locations
The Analysis Hierarchy Locations resource manages all locations within the analysis hierarchy. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the analysis hierarchy. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the analysis hierarchy. -
EisHierarchyId: integer
(int64)
Value that uniquely identifies the analysis hierarchy.
-
HierarchyDescription: string
Maximum Length:
240
Description of the analysis hierarchy. -
HierarchyName: string
Maximum Length:
120
Name of the analysis hierarchy. -
LastProcessId: integer
(int64)
Value that uniquely identifies the last create analysis hierarchy process.
-
LastRunDate: string
(date-time)
Date when the user most recently ran the create analysis hierarchy process.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the analysis hierarchy. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the analysis hierarchy. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProcessAction: string
Maximum Length:
255
Name of the action to run the create analysis hierarchy process. -
SourceSystem: string
Maximum Length:
30
Name of the source application. -
SourceSystemId: integer
(int64)
Value that uniquely identifies the source application.
-
Status: integer
(int32)
Status of the create analysis hierarchy process.
array
Analysis Hierarchy Locations
array
Links
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.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
- AnalysisHierarchyLocations
-
Parameters:
- EisHierarchyId:
$request.path.EisHierarchyId
The Analysis Hierarchy Locations resource manages all locations within the analysis hierarchy. - EisHierarchyId:
Examples
This example describes how to create analysis hierarchies.
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/analysisHierarchies"
Example 1 Request Body
The following example includes the contents of the request body in JSON format:
{ "HierarchyName": "RPORG2 Catalog", "HierarchyDescription": "RPORG2 Catalog", "SourceSystem": "GPR", "AnalysisHierarchyLocations": [ { "Location": "RPORG1" } ]}
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{ "EisHierarchyId": 300100564971696, "HierarchyName": "RPORG2 Catalog", "HierarchyDescription": "RPORG2 Catalog", "SourceSystemId": 100010026240309, "SourceSystem": "GPR", "Status": null, "LastProcessId": null, "LastRunDate": null, "CreatedBy": "APS_ALL", "CreationDate": "2022-06-08T05:34:37+00:00", "LastUpdatedBy": "APS_ALL", "LastUpdateDate": "2022-06-08T05:34:37.979+00:00", "ProcessAction": null, "AnalysisHierarchyLocations": [ { "EisHierarchyId": 300100564971696, "LocationId": 31641, "Location": "RPORG1", "Description": "31641-SEATTLE MFG", "CreatedBy": "APS_ALL", "CreationDate": "2022-06-08T05:34:37.787+00:00", "LastUpdateDate": "2022-06-08T05:34:38.098+00:00", "LastUpdatedBy": "APS_ALL", "links": [ { "rel": "self", "href": "https://server/fscmRestApi/resources/version/analysisHierarchies/300100564971696/child/AnalysisHierarchyLocations/31641", "name": "AnalysisHierarchyLocations", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://server/fscmRestApi/resources/version/analysisHierarchies/300100564971696/child/AnalysisHierarchyLocations/31641", "name": "AnalysisHierarchyLocations", "kind": "item" }, { "rel": "parent", "href": "https://server/fscmRestApi/resources/version/analysisHierarchies/300100564971696", "name": "analysisHierarchies", "kind": "item" } ] } ], "links": [ { "rel": "self", "href": "https://server/fscmRestApi/resources/version/analysisHierarchies/300100564971696", "name": "analysisHierarchies", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://server/fscmRestApi/resources/version/analysisHierarchies/300100564971696", "name": "analysisHierarchies", "kind": "item" }, { "rel": "child", "href": "https://server/fscmRestApi/resources/version/analysisHierarchies/300100564971696/child/AnalysisHierarchyLocations", "name": "AnalysisHierarchyLocations", "kind": "collection" } ] }
Example 2
This example shows how to launch the Create Analysis Hierarchies scheduled job.
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/analysisHierarchies/300100564971696/child/AnalysisHierarchyLocations"
Example 2 Request Body
{ "ProcessAction": "Create" }
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
{ "EisHierarchyId": 300100564971696, "HierarchyName": "RPORG4 Catalog", "HierarchyDescription": "RPORG4 Catalog", "SourceSystemId": 100010026240309, "SourceSystem": "GPR", "Status": 1, "LastProcessId": 192283, "LastRunDate": "2022-06-08T08:05:01.754+00:00", "CreatedBy": "APS_ALL", "CreationDate": "2022-06-08T05:34:37+00:00", "LastUpdatedBy": "APS_ALL", "LastUpdateDate": "2022-06-08T08:05:01+00:00", "ProcessAction": "Create", "links": [ { "rel": "self", "href": "https://server/fscmRestApi/resources/version/analysisHierarchies/300100564971696", "name": "analysisHierarchies", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://server/fscmRestApi/resources/version/analysisHierarchies/300100564971696", "name": "analysisHierarchies", "kind": "item" }, { "rel": "child", "href": "https://server/fscmRestApi/resources/version/analysisHierarchies/300100564971696/child/AnalysisHierarchyLocations", "name": "AnalysisHierarchyLocations", "kind": "collection" } ] }