1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Forecasts

Get all territory forecasts

get

/crmRestApi/resources/11.13.18.05/territoryForecasts

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • CurrentForecast: Finds all active forecast records.
      Finder Variables:
      • FilterByParticipantId: Finds a territory forecast record with the specified participant identifier.
        Finder Variables:
        • ForecastParticipantId; integer; The unique identifier of the forecast participant.
      • MyForecast: Finds all forecast records for a specified user.
        Finder Variables:
        • TrStatus; string; The accepted values for TrStatus are ACTIVE, PAST, and FUTURE. The forecast records for the given user are filtered based on the specified territory forecast status value.
      • PrimaryKey: Finds the territory forecast record by primary key.
        Finder Variables:
        • ForecastParticipantId; integer; The unique identifier of the territory forecast.
    • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
    • 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
    • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
    • The resource item payload will be filtered in order to contain only data (no links section, for example).
    • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
    • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

      Format: ?q=expression1;expression2

      You can use these queryable attributes to filter this collection resource using the q query parameter:
      • ClosedAmt; number; The closed revenue amount for the territory forecast.
      • CreatedBy; string; The user who created the record.
      • CreationDate; string; The date when the record was created.
      • DueDate; string; The due date for the forecast.
      • EndDate; string; The end date for the forecast.
      • FcstStatusQualifierCode; string; The status code indicating if a forecast territory is unsubmitted, submitted, or rejected.
      • ForecastHeaderId; integer; The unique identifier of the forecast.
      • ForecastName; string; The name of the forecast.
      • ForecastParticipantId; integer; The unique identifier of the participant associated with the territory forecast.
      • ForecastSeqNum; integer; The number that sorts the various forecasts into the correct sequence.
      • ForecastType; string; The type of the forecast. The accepted values are: Revenue and Overlay.
      • LastUpdateDate; string; The date when the record was last updated.
      • LastUpdateLogin; string; The login of the user who last updated the record.
      • LastUpdatedBy; string; The user who last updated the record.
      • Meaning; string; The status of the forecast. The accepted values are: Submitted, Unsubmitted, and Rejected.
      • Notes; string; The forecast summary adjustment comments.
      • OwnerResourceId; integer; The unique identifier of the party that owns the territory.
      • ParentTerritoryId; integer; The unique identifier of the parent territory.
      • ParentTerritoryOwnerResourceId; integer; The unique identifier of the parent territory owner.
      • PeriodName; string; The display name of the forecast adjustment period.
      • PipelineAmt; number; The total amount of open opportunity revenue which is set to close within the same time frame as the current forecast period.
      • StartDate; string; The start date for the forecast.
      • StatusCode; string; The status code of the forecast. The accepted values are: SUBMITTED, UNSUBMITTED, and REJECTED.
      • SubmittedBy; string; The name of the user who submitted the forecast.
      • SubmittedOn; string; The date when the forecast was submitted.
      • TerritoryHierarchyFreezeDate; string; The date on which the territory hierarchy is frozen. The forecast for a period is editable only after the territory hierarchy has been frozen for that forecasting period.
      • TerritoryId; integer; The unique identifier of the territory.
      • TerritoryLevel; number; The level of the territory in the territory hierarchy.
      • TerritoryName; string; The name of the forecast territory.
      • TerritoryVersionId; integer; The unique identifier of the territory version.
      • UserLastUpdateDate; string; The date when the user last updated the opportunity.
    • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
    Header Parameters
    • 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".
    • 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

    Default Response

    The following table describes the default response for this task.
    Headers
    • 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".
    • 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 : territoryForecasts
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : territoryForecasts-item-response
    Type: object
    Show Source
    Nested Schema : Adjustment Periods
    Type: array
    Title: Adjustment Periods
    The forecast adjustment periods resource is used to view and update the time period adjustment applied to a territory forecast.
    Show Source
    Nested Schema : Forecast Items
    Type: array
    Title: Forecast Items
    The forecast items resource is used view and update the items associated with a forecast.
    Show Source
    Nested Schema : Forecast Products
    Type: array
    Title: Forecast Products
    The forecast products resource is used to view and update the products associated with a forecast. The forecast products resource displays forecasts categorized by product.
    Show Source
    Nested Schema : Revenue Items
    Type: array
    Title: Revenue Items
    The revenue items resource is used to view the revenue items that are not included in the forecast associated with a territory.
    Show Source
    Nested Schema : territoryForecasts-forecastAdjustmentPeriods-item-response
    Type: object
    Show Source
    Nested Schema : territoryForecasts-ForecastItemDetail-item-response
    Type: object
    Show Source
    Nested Schema : territoryForecasts-forecastProducts-item-response
    Type: object
    Show Source
    Nested Schema : Product Adjustment Periods
    Type: array
    Title: Product Adjustment Periods
    The forecast product adjustment periods resource is used to view and update the time period adjustment applied to a forecast product.
    Show Source
    Nested Schema : territoryForecasts-forecastProducts-forecastProductAdjustmentPeriods-item-response
    Type: object
    Show Source
    Nested Schema : territoryForecasts-unforecastedPipeline-item-response
    Type: object
    Show Source
    Back to Top

    Examples

    The following example shows how to get all territory forecasts by submitting a get request on the REST resource using cURL.

    cURL Command

    curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territoryForecasts

    Example of Response Body

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

    {
"items": 
[20]
 
0:  
{
"ForecastParticipantId": 463773
"ForecastHeaderId": 300100018228533
"StatusCode": "UNSUBMITTED"
"DueDate": "2013-01-12"
"StartDate": "2013-04-01"
"ForecastName": "Q2-2013 - 2013/01/12"
"TerritoryHierarchyFreezeDate": "2013-01-11"
"Meaning": "Unsubmitted"
"TerritoryLevel": 4
"TerritoryId": 300100012312306
"TerritoryVersionId": 300100015404040
"TerritoryName": "ZSF_Territory_US West"
"OwnerResourceId": 100010037456217
"ForecastType": "REVENUE"
"ForecastParticipationCode": "REVENUE_AND_NONREVENUE"
"ParentTerritoryOwnerResourceId": 100010037456757
...
}
    Back to Top