Jump to

• Request
• Response

Launch one sourcing program negotiation

post

/fscmRestApi/resources/11.13.18.05/sourcingPrograms/{ProgramHeaderId}/child/sourcingProgramObjectives/{ObjectiveHeaderId}/child/sourcingProgramNegotiations

Request

Path Parameters

• ObjectiveHeaderId(required): integer(int64)
  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=
• ProgramHeaderId(required): integer(int64)
  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=

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AuctionHeaderId: integer (int64)
  Value that uniquely identifies the negotiation.
• AwardAmount: number
  Award amount identified in the objective.
• ObjectiveHeaderId: integer (int64)
  Value that uniquely identifies the objective.
• ObjectiveNegotiationId: integer (int64)
  Value that uniquely identifies the objective negotiation mapping.
• ObjectVersionNumber: integer (int32)
  Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• OverrideFlag: boolean
  Maximum Length: 1

  Value that indicates if the planned values are overridden manually.
• PlannedCurrentSpend: number
  Sum of all the negotiation current amounts of objectives.
• PlannedSavings: number
  Savings amount that the program is trying to achieve.
• PlannedSavingsPercent: number
  Savings percentage that the program is trying to achieve.
• PlannedTargetSpend: number
  Sum of Negotiation Target Spend for all the objectives.
• PlannedTitle: string
  Maximum Length: 80

  Title for the manual contributions added to the objective.
• ProgramHeaderId: integer (int64)
  Unique identifier for the program header in the program.

{
    "type":"object",
    "properties":{
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the negotiation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AwardAmount":{
            "type":"number",
            "description":"Award amount identified in the objective.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "ObjectiveHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the objective.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectiveNegotiationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the objective negotiation mapping.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OverrideFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates if the planned values are overridden manually.",
            "nullable":true
        },
        "PlannedCurrentSpend":{
            "type":"number",
            "description":"Sum of all the negotiation current amounts of objectives.",
            "nullable":true
        },
        "PlannedSavings":{
            "type":"number",
            "description":"Savings amount that the program is trying to achieve.",
            "nullable":true
        },
        "PlannedSavingsPercent":{
            "type":"number",
            "description":"Savings percentage that the program is trying to achieve.",
            "nullable":true
        },
        "PlannedTargetSpend":{
            "type":"number",
            "description":"Sum of Negotiation Target Spend for all the objectives.",
            "nullable":true
        },
        "PlannedTitle":{
            "maxLength":80,
            "type":"string",
            "description":"Title for the manual contributions added to the objective.",
            "nullable":true
        },
        "ProgramHeaderId":{
            "type":"integer",
            "description":"Unique identifier for the program header in the program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : sourcingPrograms-sourcingProgramObjectives-sourcingProgramNegotiations-item-response

Type: object

Show Source

• AuctionHeaderId: integer (int64)
  Value that uniquely identifies the negotiation.
• AwardAmount: number
  Award amount identified in the objective.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the objective row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectiveHeaderId: integer (int64)
  Value that uniquely identifies the objective.
• ObjectiveNegotiationId: integer (int64)
  Value that uniquely identifies the objective negotiation mapping.
• ObjectVersionNumber: integer (int32)
  Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• OverrideFlag: boolean
  Maximum Length: 1

  Value that indicates if the planned values are overridden manually.
• PlannedCurrentSpend: number
  Sum of all the negotiation current amounts of objectives.
• PlannedSavings: number
  Savings amount that the program is trying to achieve.
• PlannedSavingsPercent: number
  Savings percentage that the program is trying to achieve.
• PlannedTargetSpend: number
  Sum of Negotiation Target Spend for all the objectives.
• PlannedTitle: string
  Maximum Length: 80

  Title for the manual contributions added to the objective.
• ProgramHeaderId: integer (int64)
  Unique identifier for the program header in the program.

{
    "type":"object",
    "properties":{
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the negotiation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AwardAmount":{
            "type":"number",
            "description":"Award amount identified in the objective.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the objective row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ObjectiveHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the objective.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectiveNegotiationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the objective negotiation mapping.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OverrideFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates if the planned values are overridden manually.",
            "nullable":true,
            "x-queryable":true
        },
        "PlannedCurrentSpend":{
            "type":"number",
            "description":"Sum of all the negotiation current amounts of objectives.",
            "nullable":true,
            "x-queryable":true
        },
        "PlannedSavings":{
            "type":"number",
            "description":"Savings amount that the program is trying to achieve.",
            "nullable":true,
            "x-queryable":true
        },
        "PlannedSavingsPercent":{
            "type":"number",
            "description":"Savings percentage that the program is trying to achieve.",
            "nullable":true,
            "x-queryable":true
        },
        "PlannedTargetSpend":{
            "type":"number",
            "description":"Sum of Negotiation Target Spend for all the objectives.",
            "nullable":true,
            "x-queryable":true
        },
        "PlannedTitle":{
            "maxLength":80,
            "type":"string",
            "description":"Title for the manual contributions added to the objective.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramHeaderId":{
            "type":"integer",
            "description":"Unique identifier for the program header in the program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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