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

Get all collaboration planners

get

/fscmRestApi/resources/11.13.18.05/collaborationPlanners

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 planners according to the person identifier.
      Finder Variables
      • PersonId; integer; Value that uniquely identifies the collaboration planner.
    • RowFinder Find collaboration planners according to the person identifier.
      Finder Variables
      • PersonId; integer; Value that uniquely identifies the collaboration 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 collaboration planner.
    • CreationDate; string; Date and time when the user created the collaboration planner.
    • DisplayName; string; Display name of the collaboration planner. This is usually the full name.
    • Email; string; Email address of the collaboration planner. The service provider uses the canonical form of the email address; for example, j.johnson@example.com.
    • FirstName; string; First name of the collaboration planner.
    • FullAccessFlag; boolean; Contains one of the following values: Yes or No. If Yes, then the collaboration planner has access to the entire order forecast data. If No, then the collaboration planner doesn't have access to the entire order forecast data. The default value is No.
    • LastName; string; Last name of the collaboration planner.
    • LastUpdateDate; string; Date and time when the user most recently updated the collaboration planner.
    • LastUpdatedBy; string; User who most recently updated the collaboration planner.
    • PersonId; integer; Value that uniquely identifies the collaboration planner.
    • Status; string; Value that indicates the administrative status of the collaboration planner. The service provider determines the definitive value for this attribute. For example, active indicates that the collaboration planner can access order forecast data, and inactive indicates that the collaboration planner can't access order forecast data.
    • StatusCode; string; Abbreviation that identifies the status of the collaboration planner.
    • UserName; string; Login that the collaboration planner used to authenticate with the service provider directly. 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 : collaborationPlanners
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : collaborationPlanners-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    User who created the collaboration planner.
  • Read Only: true
    Date and time when the user created the collaboration planner.
  • Data Access Security
    Title: Data Access Security
    The Data Access Security child resource manages data assess security for the collaboration planners.
  • Title: Name
    Read Only: true
    Maximum Length: 240
    Display name of the collaboration planner. This is usually the full name.
  • Title: Email
    Read Only: true
    Maximum Length: 240
    Email address of the collaboration planner. The service provider uses the canonical form of the email address; for example, j.johnson@example.com.
  • Title: First Name
    Read Only: true
    Maximum Length: 150
    First name of the collaboration planner.
  • Title: Full Access
    Contains one of the following values: Yes or No. If Yes, then the collaboration planner has access to the entire order forecast data. If No, then the collaboration planner doesn't have access to the entire order forecast data. The default value is No.
  • Title: Last Name
    Read Only: true
    Maximum Length: 150
    Last name of the collaboration planner.
  • Read Only: true
    Date and time when the user most recently updated the collaboration planner.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the collaboration planner.
  • Links
  • Value that uniquely identifies the collaboration planner.
  • Value that indicates the administrative status of the collaboration planner. The service provider determines the definitive value for this attribute. For example, active indicates that the collaboration planner can access order forecast data, and inactive indicates that the collaboration planner can't access order forecast data.
  • Maximum Length: 30
    Abbreviation that identifies the status of the collaboration planner.
  • Title: User Name
    Maximum Length: 100
    Login that the collaboration planner used to authenticate with the service provider directly. This attribute is required.
Nested Schema : Data Access Security
Type: array
Title: Data Access Security
The Data Access Security child resource manages data assess security for the collaboration planners.
Show Source
Nested Schema : collaborationPlanners-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.
  • Read Only: true
    Value that uniquely identifies the data access security of the collaboration 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
  • Abbreviation that identifies the organization that receives the item.
  • Title: Organization
    Value that uniquely identifies the organization. This organization receives the shipment. It's a primary key that the application creates when it creates an organization.
  • Title: Organization
    Name of the organization that receives the item.
  • Value that uniquely identifies the procurement business unit. It's a primary key that the application creates when it creates the business unit.
  • Title: Procurement BU
    Name of the business unit. The application assigns the supplier site to this business unit.
  • Title: Security Context
    Value that identifies the level of security applied. Values include supplier or supplier site.
  • Title: Security Context
    Value that identifies the level of security applied. A list of accepted values is defined in the lookup type ORA_VCS_SECURITY_CONTEXT.
  • Title: Ship-from Supplier
    Value that uniquely identifies the supplier who ships the item. It's a primary key that the application creates when it creates the supplier.
  • Title: Ship-from Supplier
    Name of the supplier that ships the item.
  • Title: Ship-from Supplier Site
    Value that uniquely identifies the supplier site who ships the item. It's a primary key that the application creates when it creates the supplier site.
  • Title: Ship-from Supplier Site
    Name of the supplier site that ships the item.
  • Title: Source System
    Value that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include External or Oracle.
  • Abbreviation that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include ORA_VCS_SRCSYSTEM_EXTERNAL or ORA_VCS_SRCSYSTEM_ORACLE.
Back to Top

Examples

This example describes how to get all collaboration 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/collaborationPlanners"

Example Response Body

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

{
    "items": [
        {
            "PersonId": 3927,
            "UserName": "SmithJohn",
            "FirstName": "John",
            "LastName": "Smith",
            "DisplayName": "Smith,John",
            "Email": "john.smith@example.com",
            "StatusCode": "A",
            "Status": "Active",
            "CreatedBy": "AdminUser",
            "CreationDate": "2018-06-12T01:44:21.126+00:00",
            "LastUpdatedBy": "AdminUser",
            "LastUpdateDate": "2018-06-12T01:45:22.917+00:00",
            "FullAccessFlag": "false",
            "dataAccessSecurity": [
              {
              ...
              },
              {
              ...
              },
            ]
        },
        {
             ...
        }
   ]
 ...
}
Back to Top