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

Get all demand planners

get

/fscmRestApi/resources/11.13.18.05/collaborationDemandPlanners

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 Find collaboration demand planners according to the demand planner identifier.
      Finder Variables
      • DemandPlannerId; integer; Value that uniquely identifies the demand planner.
  • 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 demand planner.
    • CreationDate; string; Date and time when the user created the demand planner.
    • DemandPlannerId; integer; Value that uniquely identifies the demand planner.
    • DisplayName; string; Name of the user displayed on the UI.
    • Email; string; Primary work email of the user.
    • FirstName; string; Person first name.
    • FullAccessFlag; boolean; Contains one of the following values: Yes or No. If Yes, then the demand planner has access to the entire customer forecast data. If No, then the demand planner doesn't have access to the entire customer forecast data. The default value is No.
    • LastName; string; Person last name.
    • LastUpdateDate; string; Date and time when the user most recently updated the demand planner.
    • LastUpdatedBy; string; User who most recently updated the demand planner.
    • ListName; string; Listed name of the user.
    • ParticipantCode; string; Abbreviation that identifies the user's participant type. A list of accepted values is ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE.
    • ParticipantName; string; The user's participant type.
    • PersonPartyId; integer; Value that uniquely identifies the customer contact.
    • Status; string; Value that indicates the administrative status of the demand planner. The service provider determines the definitive value for this attribute. For example, Active indicates that the demand planner can access order forecast data, and Inactive indicates that the demand planner can't access order forecast data. The default value is Active.
    • StatusCode; string; Abbreviation that identifies the status of the demand planner.
    • UserName; string; Login that the demand planner used to directly authenticate with the service provider. This attribute is required.
  • 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 : collaborationDemandPlanners
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : collaborationDemandPlanners-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    User who created the demand planner.
  • Read Only: true
    Date and time when the user created the demand planner.
  • Data Access Security
    Title: Data Access Security
    The Data Access Security resource manages the data assess security for the demand planner.
  • Read Only: true
    Value that uniquely identifies the demand planner.
  • Read Only: true
    Maximum Length: 240
    Name of the user displayed on the UI.
  • Document Visibility
    Title: Document Visibility
    The Document Visibility resource manages the visibility to documents for the demand planner.
  • Title: Email
    Maximum Length: 240
    Primary work email of the user.
  • Read Only: true
    Maximum Length: 150
    Person first name.
  • Contains one of the following values: Yes or No. If Yes, then the demand planner has access to the entire customer forecast data. If No, then the demand planner doesn't have access to the entire customer forecast data. The default value is No.
  • Maximum Length: 150
    Person last name.
  • Read Only: true
    Date and time when the user most recently updated the demand planner.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the demand planner.
  • Links
  • Read Only: true
    Maximum Length: 240
    Listed name of the user.
  • Maximum Length: 30
    Abbreviation that identifies the user's participant type. A list of accepted values is ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    The user's participant type.
  • Value that uniquely identifies the customer contact.
  • Maximum Length: 80
    Value that indicates the administrative status of the demand planner. The service provider determines the definitive value for this attribute. For example, Active indicates that the demand planner can access order forecast data, and Inactive indicates that the demand planner can't access order forecast data. The default value is Active.
  • Maximum Length: 30
    Default Value: ORA_VCS_ACTIVE
    Abbreviation that identifies the status of the demand planner.
  • Maximum Length: 100
    Login that the demand planner used to directly authenticate with the service provider. This attribute is required.
Nested Schema : Data Access Security
Type: array
Title: Data Access Security
The Data Access Security resource manages the data assess security for the demand planner.
Show Source
Nested Schema : Document Visibility
Type: array
Title: Document Visibility
The Document Visibility resource manages the visibility to documents for the demand planner.
Show Source
Nested Schema : collaborationDemandPlanners-dataAccessSecurity-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    User who created the data access security.
  • Read Only: true
    Date and time when the user created the data access security.
  • Value that uniquely identifies the customer in the customer forecast that receives the item. It's a primary key that the application creates when it creates the customer.
  • Maximum Length: 360
    Name of the customer in the customer forecast that receives the item.
  • Maximum Length: 360
    Number that identifies the customer in the customer forecast that receives the item.
  • Read Only: true
    Maximum Length: 960
    Address of the customer site in the customer forecast that receives the item.
  • Value that uniquely identifies the customer site in the customer forecast that receives the item. It's a primary key that the application creates when it creates the customer.
  • Read Only: true
    Maximum Length: 30
    Location of the customer site in the customer forecast that receives the item.
  • Maximum Length: 30
    Number that identifies customer site in the customer forecast that receives the item.
  • Read Only: true
    Value that uniquely identifies the specific data security access granted to the demand planner.
  • Read Only: true
    Date and time when the user most recently updated the data access security.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the data access security.
  • Links
  • Read Only: true
    Maximum Length: 80
    Value that identifies the level of security applied. Values include Customer or Customer Site. The default value is Customer.
  • Maximum Length: 30
    Abbreviation that identifies the level of security applied. A list of accepted values is defined in the lookup type ORA_VCS_SECURITY_CONTEXT.
Nested Schema : collaborationDemandPlanners-documentVisibility-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 80
    Level of the customer a document accepts for collaboration.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the customer level of the document. A list of accepted values is defined in the lookup type ORA_VCS_LVL_CUSTOMER.
  • Read Only: true
    Value that uniquely identifies the document definition.
  • Abbreviation that identifies the type of document used for collaboration.
  • Read Only: true
    Maximum Length: 80
    Type of document used for collaboration.
  • Read Only: true
    Value that uniquely identifies the specific document visibility assigned to the demand planner.
  • Read Only: true
    Maximum Length: 80
    Level of the item a document accepts for collaboration.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the item level of the document. A list of accepted values is defined in the lookup type ORA_VCS_LVL_ITEM.
  • Links
  • Read Only: true
    Maximum Length: 80
    Level of the organization a document accepts for collaboration.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the organization level of the document. A list of accepted values is defined in the lookup type ORA_VCS_LVL_ORGANIZATION.
  • Read Only: true
    Maximum Length: 80
    Current state of the document definition.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the current state of the document definition.
Back to Top

Examples

This example describes how to get all demand planners.

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

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners?expand=dataAccessSecurity&q=dataAccessSecurity.CustomerName='Aegon Fitness Equipment'&onlyData=true

Example Response Body

The following shows an example of the response body in JSON format.
"{
    "items": [
        {
            "ConditionEventCodeId": 300100171239899,
            "ConditionEventCode": "D_CODE",
            "ConditionEventName": "D_CODE",
            "ConditionEventDescription": "D_CODE",
            "ConditionEventTypeCode": "DIAGNOSTIC",
            "ConditionEventTypeName": "Diagnostic code",
            "ConditionEventCategoryCode": null,
            "ConditionEventCategoryName": null,
            "SourceReferenceId": null,
            "ActiveEndDate": null,
            "ConditionEventCodeDisableFlag": null,
            "CreatedBy": "MNT_QA",
            "CreationDate": "2018-10-03T15:23:57+00:00",
            "LastUpdateDate": "2018-10-03T15:24:26.859+00:00",
            "LastUpdateLogin": "76D4C2AE938D62F0E0534280F50A8693",
            "LastUpdatedBy": "MNT_QA"
}"
Back to Top