Get all negotiation calendar events

get

/fscmRestApi/resources/11.13.18.05/supplierNegotiationCalendarEvents

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 Value that uniquely identifies the negotiation calendar activity.
      Finder Variables
      • ActivityId; string; Value that uniquely identifies the negotiation calendar activity.
    • findEventsForCalendar Finds the unique row for negotiation events.
      Finder Variables
      • EndDate; string;
      • StartDate; string;
  • 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:
    • ActivityEndDate; string; Date on which the negotiation calendar is planned to end.
    • ActivityId; string; Value that uniquely identifies the negotiation calendar activity.
    • ActivityStartDate; string; Date on which the negotiation calendar is planned to begin.
    • ActivityStatus; string; Status of a negotiation displayed to the user.
    • ActivityTitle; string; Value that uniquely identifies the negotiation calendar activity.
    • AssignedTo; string; Name of the collaboration team member to whom the task is assigned.
    • AuctionHeaderId; integer; Auction Header ID
    • AuctionStatus; string; Status of a negotiation displayed to the user.
    • AuctionTitle; string; Indicates the auction title.
    • AwardByDate; string; Date when the application awards the negotiation.
    • BUName; string; Name of the procurement business unit under which the negotiation was created.
    • CloseBiddingDate; string; Date and time when the auction was set to close for bidding.
    • DocumentNumber; string; Negotiation number of the negotiation.
    • DocumentTypeCode; string; Code for the type of document. Value can be STANDARD or BLANKET, corresponding to a standard purchase order or blanket purchase agreement, respectively.
    • DocumentTypeDisplayName; string; Value that uniquely identifies the document type. Possible values: RFQ, RFI, Auction.
    • DraftLocked; string; Unique identifier for the user who locked the draft negotiation.
    • EventType; string; Indicates the different event types displayed in the negotiation calendar. My Events indicates the events where the user is the owner or a member of the collaboration team. Other Events indicates the events where the user is the Procurement Agent for the Business Unit, excluding My Events. Collaboration Tasks indicates the tasks where the user is part of the collaboration team or is the owner. Project Tasks displays all project-related tasks.
    • LastPausedDate; string; Date when the negotiation was paused.
    • NegApprovalStatus; string; Approval status of a negotiation.
    • OpenBiddingDate; string; Date and time when the auction is available for bidding.
    • Outcome; string; Display name of the purchasing document that the application creates at the end of the negotiation process. Use page Manage Document Styles in the Setup and Maintenance work area to examine and update the values that you can use for this attribute.
    • PrimaryResourceName; string; Name of the resource leading the task.
    • ProcurementBUId; integer; Value that finds the supplier sites using Procurement Business Unit Id as the primary key.
    • ProjectName; string; Name of the project associated with the negotiation.
    • StaggeredClosingFlag; boolean; Contains one of the following values: true or false. If true, then allow lines to use staggered close dates in the negotiation. If false, then don't allow. The default value is false.
    • TargetDate; string; Date when the application expects the collaboration team member to finishes the assigned task.
    • TaskComplete; number; Task completion percentage, indicating progress toward completion.
    • TaskName; string; Name of the task that the application assigned to the collaboration team member.
    • TaskStatus; string; Indicates the status of the assigned task (e.g., Not Started, Completed).
    • TechnicalEvaluationStatus; string; Indicates the technical evaluation stage completion status.
    • TechnicalLockStatus; string; Used to store the technical part's lock status for a two part RFQ.
    • TimeRemaining; string; Number of lines in the negotiation, without any response from the suppliers.
    • ViewByDate; string; Date and time when the seller negotiation becomes available for bidder preview.
  • 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 : supplierNegotiationCalendarEvents
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : supplierNegotiationCalendarEvents-item-response
Type: object
Show Source
  • Read Only: true
    Date on which the negotiation calendar is planned to end.
  • Read Only: true
    Maximum Length: 92
    Value that uniquely identifies the negotiation calendar activity.
  • Read Only: true
    Date on which the negotiation calendar is planned to begin.
  • Read Only: true
    Status of a negotiation displayed to the user.
  • Read Only: true
    Maximum Length: 402
    Value that uniquely identifies the negotiation calendar activity.
  • Read Only: true
    Maximum Length: 240
    Name of the collaboration team member to whom the task is assigned.
  • Read Only: true
    Auction Header ID
  • Read Only: true
    Maximum Length: 25
    Status of a negotiation displayed to the user.
  • Read Only: true
    Maximum Length: 80
    Indicates the auction title.
  • Read Only: true
    Date when the application awards the negotiation.
  • Read Only: true
    Maximum Length: 240
    Name of the procurement business unit under which the negotiation was created.
  • Read Only: true
    Date and time when the auction was set to close for bidding.
  • Read Only: true
    Maximum Length: 240
    Negotiation number of the negotiation.
  • Read Only: true
    Maximum Length: 30
    Code for the type of document. Value can be STANDARD or BLANKET, corresponding to a standard purchase order or blanket purchase agreement, respectively.
  • Read Only: true
    Maximum Length: 80
    Value that uniquely identifies the document type. Possible values: RFQ, RFI, Auction.
  • Read Only: true
    Maximum Length: 1
    Unique identifier for the user who locked the draft negotiation.
  • Read Only: true
    Maximum Length: 18
    Indicates the different event types displayed in the negotiation calendar. My Events indicates the events where the user is the owner or a member of the collaboration team. Other Events indicates the events where the user is the Procurement Agent for the Business Unit, excluding My Events. Collaboration Tasks indicates the tasks where the user is part of the collaboration team or is the owner. Project Tasks displays all project-related tasks.
  • Read Only: true
    Date when the negotiation was paused.
  • Links
  • Read Only: true
    Maximum Length: 30
    Approval status of a negotiation.
  • Read Only: true
    Maximum Length: 255
    Status code that's stored internally for a negotiation.
  • Read Only: true
    Maximum Length: 255
    Status of a negotiation displayed to the user.
  • Read Only: true
    Date and time when the auction is available for bidding.
  • Read Only: true
    Maximum Length: 240
    Display name of the purchasing document that the application creates at the end of the negotiation process. Use page Manage Document Styles in the Setup and Maintenance work area to examine and update the values that you can use for this attribute.
  • Read Only: true
    Maximum Length: 240
    Name of the resource leading the task.
  • Read Only: true
    Value that finds the supplier sites using Procurement Business Unit Id as the primary key.
  • Read Only: true
    Maximum Length: 240
    Name of the project associated with the negotiation.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then allow lines to use staggered close dates in the negotiation. If false, then don't allow. The default value is false.
  • Read Only: true
    Date when the application expects the collaboration team member to finishes the assigned task.
  • Read Only: true
    Task completion percentage, indicating progress toward completion.
  • Read Only: true
    Maximum Length: 4000
    Name of the task that the application assigned to the collaboration team member.
  • Read Only: true
    Maximum Length: 9
    Indicates the status of the assigned task (e.g., Not Started, Completed).
  • Read Only: true
    Maximum Length: 12
    Indicates the type of calendar event, specifying whether it represents a negotiation, task, or project event.
  • Read Only: true
    Maximum Length: 30
    Indicates the technical evaluation stage completion status.
  • Read Only: true
    Maximum Length: 30
    Used to store the technical part's lock status for a two part RFQ.
  • Read Only: true
    Maximum Length: 255
    Number of lines in the negotiation, without any response from the suppliers.
  • Read Only: true
    Date and time when the seller negotiation becomes available for bidder preview.
Back to Top