1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Supply Chain Planning
  4. Collaboration Aggregation Schedules

Get all aggregation schedules

get

/fscmRestApi/resources/11.13.18.05/collaborationAggregationSchedules

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

    • PrimaryKey Finds aggregation schedules according to the primary key.
      Finder Variables
      • ScheduleId; integer; Abbreviation that identifies the aggregation schedule.
    • findActiveSchedule Find aggregation schedules according to active status.
      Finder Variables
      • findBySourceScheduleId Find aggregation schedules according to the source schedule identifier.
        Finder Variables
        • SourceScheduleId; integer; Abbreviation that identifies the aggregation source schedule.
    • 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:
      • CreatedBy; string; User who created the collaboration aggregation schedule.
      • CreationDate; string; Date and time when the collaboration aggregation schedule was created.
      • DisplayedAggregationLevel; string; Abbreviation that identifies the displayed aggregation level for supply chain collaboration. A list of acceptable values is defined in the lookup type ORA_VCS_AGGREG_LEVEL .
      • EffectiveFromDate; string; Date and time from when the collaboration aggregation schedule is effective.
      • EffectiveToDate; string; Date and time from when the collaboration aggregation schedule is no longer effective.
      • LastUpdateDate; string; Date and time of the last update of the collaboration aggregation schedule.
      • LastUpdatedBy; string; User who last updated the collaboration aggregation schedule..
      • QuarterlyTypeCode; string; Abbreviation that identifies the quarterly type of the aggregation schedule for supply chain collaboration. A list of acceptable values is defined in the lookup type ORA_VCS_BUCKET_AGGR_LEVEL .
      • ScheduleId; integer; Value that uniquely identifies the aggregation schedule for supply chain collaboration.
      • SourceScheduleId; integer; Value that uniquely identifies the source schedule for supply chain collaboration.
      • StatusCode; string; Code that identifies the current state of the collaboration aggregation schedule for supply chain collaboration. A list of accepted values is defined in the lookup type ORA_VCS_FORECAST_PROCESS_STATU.
    • 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 : collaborationAggregationSchedules
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : collaborationAggregationSchedules-item-response
    Type: object
    Show Source
    • Read Only: true
      Maximum Length: 64
      User who created the collaboration aggregation schedule.
    • Read Only: true
      Date and time when the collaboration aggregation schedule was created.
    • Title: Displayed Aggregation Level
      Maximum Length: 30
      Abbreviation that identifies the displayed aggregation level for supply chain collaboration. A list of acceptable values is defined in the lookup type ORA_VCS_AGGREG_LEVEL .
    • Title: Effective from Date
      Read Only: true
      Date and time from when the collaboration aggregation schedule is effective.
    • Title: Effective to Date
      Read Only: true
      Date and time from when the collaboration aggregation schedule is no longer effective.
    • Title: Last Updated Date
      Read Only: true
      Date and time of the last update of the collaboration aggregation schedule.
    • Read Only: true
      Maximum Length: 64
      User who last updated the collaboration aggregation schedule..
    • Links
    • Title: Schedule
      Read Only: true
      Maximum Length: 255
      Name of the collaboration aggregation schedule.
    • Title: Quarterly Type
      Read Only: true
      Maximum Length: 20
      Abbreviation that identifies the quarterly type of the aggregation schedule for supply chain collaboration. A list of acceptable values is defined in the lookup type ORA_VCS_BUCKET_AGGR_LEVEL .
    • Read Only: true
      Value that uniquely identifies the aggregation schedule for supply chain collaboration.
    • Read Only: true
      Value that uniquely identifies the source schedule for supply chain collaboration.
    • Read Only: true
      Maximum Length: 30
      Default Value: I
      Code that identifies the current state of the collaboration aggregation schedule for supply chain collaboration. A list of accepted values is defined in the lookup type ORA_VCS_FORECAST_PROCESS_STATU.
    Links
    activateSchedule
    Activates the aggregation schedule for supply chain collaboration.
    Back to Top

    Examples

    This example describes how to get all aggregation schedules.

    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/collaborationAggregationSchedules"

    Example Response Body

    The following example includes the contents of the response body in JSON format:
    {
  "items" : [ {
    "SourceScheduleId" : "100000016383001",
    "DisplayedAggregationLevel" : "ORA_VCS_WEEK_DAY",
    "QuarterlyTypeCode" : "4/4/5",
    "LastUpdateDate" : "2024-02-08T09:22:25.006+00:00",
    "EffectiveFromDate" : "2008-01-07",
    "EffectiveToDate" : "2032-05-31",
    "@context" : {
      "key" : "300100586142251",
      "headers" : {
        "ETag" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000001178"
      },
      "links" : [ {
       . . .
      }, {
        ". . .
      } ]
    }
  } ],
  "count" : 1,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ {
    . . .
  }, {
    . . .
  } ]
}
    Back to Top