Jump to

• Request
• Response

Get one negotiation calendar event

get

/fscmRestApi/resources/11.13.18.05/supplierNegotiationCalendarEvents/{ActivityId}

Request

Path Parameters

• ActivityId(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  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).
• fields: string
  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
• links: string
  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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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".
• REST-Framework-Version: string
  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

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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".
• REST-Framework-Version:
  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-item-response

Type: object

Show Source

• ActivityEndDate: string (date-time)
  Read Only: true

  Date on which the negotiation calendar is planned to end.
• ActivityId: string
  Read Only: true

  Maximum Length: 92

  Value that uniquely identifies the negotiation calendar activity.
• ActivityStartDate: string (date-time)
  Read Only: true

  Date on which the negotiation calendar is planned to begin.
• ActivityStatus: string
  Read Only: true

  Status of a negotiation displayed to the user.
• ActivityTitle: string
  Read Only: true

  Maximum Length: 402

  Value that uniquely identifies the negotiation calendar activity.
• AssignedTo: string
  Read Only: true

  Maximum Length: 240

  Name of the collaboration team member to whom the task is assigned.
• AuctionHeaderId: integer (int64)
  Read Only: true

  Auction Header ID
• AuctionStatus: string
  Read Only: true

  Maximum Length: 25

  Status of a negotiation displayed to the user.
• AuctionTitle: string
  Read Only: true

  Maximum Length: 80

  Indicates the auction title.
• AwardByDate: string (date-time)
  Read Only: true

  Date when the application awards the negotiation.
• BUName: string
  Read Only: true

  Maximum Length: 240

  Name of the procurement business unit under which the negotiation was created.
• CloseBiddingDate: string (date-time)
  Read Only: true

  Date and time when the auction was set to close for bidding.
• DocumentNumber: string
  Read Only: true

  Maximum Length: 240

  Negotiation number of the negotiation.
• DocumentTypeCode: string
  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.
• DocumentTypeDisplayName: string
  Read Only: true

  Maximum Length: 80

  Value that uniquely identifies the document type. Possible values: RFQ, RFI, Auction.
• DraftLocked: string
  Read Only: true

  Maximum Length: 1

  Unique identifier for the user who locked the draft negotiation.
• EventType: string
  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.
• LastPausedDate: string (date-time)
  Read Only: true

  Date when the negotiation was paused.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NegApprovalStatus: string
  Read Only: true

  Maximum Length: 30

  Approval status of a negotiation.
• NegotiationStatusCode: string
  Read Only: true

  Maximum Length: 255

  Status code that's stored internally for a negotiation.
• NegotiationStatusDisplay: string
  Read Only: true

  Maximum Length: 255

  Status of a negotiation displayed to the user.
• OpenBiddingDate: string (date-time)
  Read Only: true

  Date and time when the auction is available for bidding.
• Outcome: string
  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.
• PrimaryResourceName: string
  Read Only: true

  Maximum Length: 240

  Name of the resource leading the task.
• ProcurementBUId: integer (int64)
  Read Only: true

  Value that finds the supplier sites using Procurement Business Unit Id as the primary key.
• ProjectName: string
  Read Only: true

  Maximum Length: 240

  Name of the project associated with the negotiation.
• StaggeredClosingFlag: boolean
  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.
• TargetDate: string (date-time)
  Read Only: true

  Date when the application expects the collaboration team member to finishes the assigned task.
• TaskComplete: number
  Read Only: true

  Task completion percentage, indicating progress toward completion.
• TaskName: string
  Read Only: true

  Maximum Length: 4000

  Name of the task that the application assigned to the collaboration team member.
• TaskStatus: string
  Read Only: true

  Maximum Length: 9

  Indicates the status of the assigned task (e.g., Not Started, Completed).
• TaskType: string
  Read Only: true

  Maximum Length: 12

  Indicates the type of calendar event, specifying whether it represents a negotiation, task, or project event.
• TechnicalEvaluationStatus: string
  Read Only: true

  Maximum Length: 30

  Indicates the technical evaluation stage completion status.
• TechnicalLockStatus: string
  Read Only: true

  Maximum Length: 30

  Used to store the technical part's lock status for a two part RFQ.
• TimeRemaining: string
  Read Only: true

  Maximum Length: 255

  Number of lines in the negotiation, without any response from the suppliers.
• ViewByDate: string (date-time)
  Read Only: true

  Date and time when the seller negotiation becomes available for bidder preview.

{
    "type":"object",
    "properties":{
        "ActivityEndDate":{
            "type":"string",
            "description":"Date on which the negotiation calendar is planned to end.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityId":{
            "maxLength":92,
            "type":"string",
            "description":"Value that uniquely identifies the negotiation calendar activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityStartDate":{
            "type":"string",
            "description":"Date on which the negotiation calendar is planned to begin.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityStatus":{
            "type":"string",
            "description":"Status of a negotiation displayed to the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityTitle":{
            "maxLength":402,
            "type":"string",
            "description":"Value that uniquely identifies the negotiation calendar activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedTo":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the collaboration team member to whom the task is assigned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Auction Header ID",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AuctionStatus":{
            "maxLength":25,
            "type":"string",
            "description":"Status of a negotiation displayed to the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AuctionTitle":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates the auction title.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AwardByDate":{
            "type":"string",
            "description":"Date when the application awards the negotiation.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BUName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the procurement business unit under which the negotiation was created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CloseBiddingDate":{
            "type":"string",
            "description":"Date and time when the auction was set to close for bidding.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Negotiation number of the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the type of document. Value can be STANDARD or BLANKET, corresponding to a standard purchase order or blanket purchase agreement, respectively.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentTypeDisplayName":{
            "maxLength":80,
            "type":"string",
            "description":"Value that uniquely identifies the document type. Possible values: RFQ, RFI, Auction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DraftLocked":{
            "maxLength":1,
            "type":"string",
            "description":"Unique identifier for the user who locked the draft negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventType":{
            "maxLength":18,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastPausedDate":{
            "type":"string",
            "description":"Date when the negotiation was paused.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NegApprovalStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Approval status of a negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NegotiationStatusCode":{
            "maxLength":255,
            "type":"string",
            "description":"Status code that's stored internally for a negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NegotiationStatusDisplay":{
            "maxLength":255,
            "type":"string",
            "description":"Status of a negotiation displayed to the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OpenBiddingDate":{
            "type":"string",
            "description":"Date and time when the auction is available for bidding.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Outcome":{
            "maxLength":240,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryResourceName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the resource leading the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that finds the supplier sites using Procurement Business Unit Id as the primary key.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProjectName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the project associated with the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StaggeredClosingFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetDate":{
            "type":"string",
            "description":"Date when the application expects the collaboration team member to finishes the assigned task.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskComplete":{
            "type":"number",
            "description":"Task completion percentage, indicating progress toward completion.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskName":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the task that the application assigned to the collaboration team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskStatus":{
            "maxLength":9,
            "type":"string",
            "description":"Indicates the status of the assigned task (e.g., Not Started, Completed).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskType":{
            "maxLength":12,
            "type":"string",
            "description":"Indicates the type of calendar event, specifying whether it represents a negotiation, task, or project event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TechnicalEvaluationStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the technical evaluation stage completion status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TechnicalLockStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Used to store the technical part's lock status for a two part RFQ.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TimeRemaining":{
            "maxLength":255,
            "type":"string",
            "description":"Number of lines in the negotiation, without any response from the suppliers.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ViewByDate":{
            "type":"string",
            "description":"Date and time when the seller negotiation becomes available for bidder preview.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top