Jump to

• Request
• Response

Update one sourcing program

patch

/fscmRestApi/resources/11.13.18.05/sourcingPrograms/{ProgramHeaderId}

Request

Path Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CategoryId: integer (int64)
  Indicates the unique identifier of category.
• Comments: string
  Maximum Length: 4000

  Comments provided while creating the program.
• CurrencyCode: string
  Maximum Length: 15

  Base currency code in which the negotiation will be conducted.
• CurrentSpend: number
  Current spend for which the program is created.
• DisplayPhase: string
  Maximum Length: 255

  Description of the program phase.
• DisplayStatus: string
  Maximum Length: 255

  Description of the program status.
• EndDate: string (date)
  The date when the program ends.
• GlobalProgramFlag: boolean
  Maximum Length: 1

  Value that indicates if the program is global.
• ListName: string
  Maximum Length: 301

  List name of the person in the program.
• PersonId: integer (int64)
  Identifier of the person who created the program.
• ProcurementBUId: integer (int64)
  Unique identifier of the procurement business unit for which the program was created. It's populated only when the program isn't global.
• ProgramHeaderId: integer (int64)
  Value that uniquely identifies the program.
• ProgramPhase: string
  Maximum Length: 20

  Determines phase of the program.
• ProgramStatus: string
  Maximum Length: 30

  Determines status of the program.
• PurchasingCatFlag: boolean
  Maximum Length: 1

  Indicates whether the category associated with the program is purchasing category.
• RateDate: string (date)
  Conversion date for the selected rate type.
• RateType: string
  Maximum Length: 30

  Rate type selected for the program.
• Savings: number
  Savings amount that the program is trying to achieve.
• SavingsPercent: number
  Savings percentage that the program is trying to achieve.
• sourcingProgramMembers: array Sourcing Program Team Members
  Title: Sourcing Program Team Members

  Details about an organization's sourcing program and its associated team members.
• sourcingProgramObjectives: array Sourcing Program Objectives
  Title: Sourcing Program Objectives

  Details about an organization's sourcing program and its associated objectives.
• StartDate: string (date)
  Date when the program starts.
• Synopsis: string
  Maximum Length: 4000

  Program synopsis as defined by the user.
• TargetSpend: number
  Target spend that the program is trying to achieve.
• Title: string
  Maximum Length: 80

  Program title defined by the user.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "type":"integer",
            "description":"Indicates the unique identifier of category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Comments":{
            "maxLength":4000,
            "type":"string",
            "description":"Comments provided while creating the program.",
            "nullable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Base currency code in which the negotiation will be conducted.",
            "nullable":true
        },
        "CurrentSpend":{
            "type":"number",
            "description":"Current spend for which the program is created.",
            "nullable":true
        },
        "DisplayPhase":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the program phase.",
            "nullable":true
        },
        "DisplayStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the program status.",
            "nullable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The date when the program ends.",
            "format":"date",
            "nullable":true
        },
        "GlobalProgramFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates if the program is global.",
            "nullable":false
        },
        "ListName":{
            "maxLength":301,
            "type":"string",
            "description":"List name of the person in the program.",
            "nullable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Identifier of the person who created the program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Unique identifier of the procurement business unit for which the program was created. It's populated only when the program isn't global.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProgramHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProgramPhase":{
            "maxLength":20,
            "type":"string",
            "description":"Determines phase of the program.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProgramStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Determines status of the program.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PurchasingCatFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the category associated with the program is purchasing category.",
            "nullable":true
        },
        "RateDate":{
            "type":"string",
            "description":"Conversion date for the selected rate type.",
            "format":"date",
            "nullable":true
        },
        "RateType":{
            "maxLength":30,
            "type":"string",
            "description":"Rate type selected for the program.",
            "nullable":true
        },
        "Savings":{
            "type":"number",
            "description":"Savings amount that the program is trying to achieve.",
            "nullable":true
        },
        "SavingsPercent":{
            "type":"number",
            "description":"Savings percentage that the program is trying to achieve.",
            "nullable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the program starts.",
            "format":"date",
            "nullable":true
        },
        "Synopsis":{
            "maxLength":4000,
            "type":"string",
            "description":"Program synopsis as defined by the user.",
            "nullable":true
        },
        "TargetSpend":{
            "type":"number",
            "description":"Target spend that the program is trying to achieve.",
            "nullable":true
        },
        "Title":{
            "maxLength":80,
            "type":"string",
            "description":"Program title defined by the user.",
            "nullable":true
        },
        "sourcingProgramMembers":{
            "title":"Sourcing Program Team Members",
            "type":"array",
            "description":"Details about an organization's sourcing program and its associated team members.",
            "items":{
                "$ref":"#/components/schemas/sourcingPrograms-sourcingProgramMembers-item-patch-request"
            }
        },
        "sourcingProgramObjectives":{
            "title":"Sourcing Program Objectives",
            "type":"array",
            "description":"Details about an organization's sourcing program and its associated objectives.",
            "items":{
                "$ref":"#/components/schemas/sourcingPrograms-sourcingProgramObjectives-item-patch-request"
            }
        }
    }
}

Nested Schema : Sourcing Program Team Members

Type: array

Title: Sourcing Program Team Members

Details about an organization's sourcing program and its associated team members.

Show Source

• Array of: object sourcingPrograms-sourcingProgramMembers-item-patch-request

{
    "title":"Sourcing Program Team Members",
    "type":"array",
    "description":"Details about an organization's sourcing program and its associated team members.",
    "items":{
        "$ref":"#/components/schemas/sourcingPrograms-sourcingProgramMembers-item-patch-request"
    }
}

Nested Schema : Sourcing Program Objectives

Type: array

Title: Sourcing Program Objectives

Details about an organization's sourcing program and its associated objectives.

Show Source

• Array of: object sourcingPrograms-sourcingProgramObjectives-item-patch-request

{
    "title":"Sourcing Program Objectives",
    "type":"array",
    "description":"Details about an organization's sourcing program and its associated objectives.",
    "items":{
        "$ref":"#/components/schemas/sourcingPrograms-sourcingProgramObjectives-item-patch-request"
    }
}

Nested Schema : sourcingPrograms-sourcingProgramMembers-item-patch-request

Type: object

Show Source

• AccessTypeCode: string
  Maximum Length: 30

  Value that identifies the agent access for the lookup code. Valid value is MANAGE_NEGOTIATIONS.
• MemberType: string
  Maximum Length: 1

  Value that identifies the program team member type.
• Note: string
  Maximum Length: 4000

  Note entered for the program team member.
• 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.
• PersonId: integer (int64)
  Value that uniquely identifies the program team member name.
• ProgramHeaderId: integer (int64)
  Unique identifier for the program header in the program.
• TeamMemberId: integer (int64)
  Value that uniquely identifies the program team member name.

{
    "type":"object",
    "properties":{
        "AccessTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the agent access for the lookup code. Valid value is MANAGE_NEGOTIATIONS.",
            "nullable":true
        },
        "MemberType":{
            "maxLength":1,
            "type":"string",
            "description":"Value that identifies the program team member type.",
            "nullable":true
        },
        "Note":{
            "maxLength":4000,
            "type":"string",
            "description":"Note entered for the program team member.",
            "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
            }
        },
        "PersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the program team member name.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProgramHeaderId":{
            "type":"integer",
            "description":"Unique identifier for the program header in the program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TeamMemberId":{
            "type":"integer",
            "description":"Value that uniquely identifies the program team member name.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : sourcingPrograms-sourcingProgramObjectives-item-patch-request

Type: object

Show Source

• CategoryId: integer (int64)
  Unique identifier of the category.
• CurrentSpend: number
  Sum of the current Amount of all award completed negotiations within the objective.
• Description: string
  Maximum Length: 4000

  Description of the objective.
• EndDate: string (date)
  Date when the objective ends.
• Name: string
  Maximum Length: 80

  Name of the objective.
• ObjectiveHeaderId(required): integer (int64)
  Value that uniquely identifies the objective.
• ObjectiveType: string
  Maximum Length: 30

  Description of the objective type.
• ProgramHeaderId(required): integer (int64)
  Unique identifier for the program header in the program.
• PurchasingCatFlag: boolean
  Maximum Length: 1

  Value that indicates if the category associated with the program is purchasing category.
• RemainingTargetSpend: number
  Value that indicates that target spend amount hasn't been allocated to the negotiation
• RollUpFlag: boolean
  Maximum Length: 1

  Value that indicates whether the savings and spend values of the objective's negotiations will be counted for program level spend and savings.
• Savings: number
  Savings amount that the program is trying to achieve.
• SavingsPercent: number
  Savings percentage that the program is trying to achieve.
• sourcingProgramNegotiations: array Sourcing Program Objective Negotiations
  Title: Sourcing Program Objective Negotiations

  Details about an organization's sourcing program and its associated negotiations.
• StartDate: string (date)
  Date when the objective starts.
• Status: string
  Maximum Length: 30

  Description of the objective status.
• TargetSpend: number
  Target spend that the program is trying to achieve.
• TotalPlannedCurrentSpend: number
  Sum of all the negotiation current amounts of objectives.
• TotalPlannedSavingGoalPercent: number
  Savings percentage that the program is trying to achieve.
• TotalPlannedTargetSpend: number
  Sum of Negotiation Target Spend for all the objectives.

{
    "required":[
        "ObjectiveHeaderId",
        "ProgramHeaderId"
    ],
    "type":"object",
    "properties":{
        "CategoryId":{
            "type":"integer",
            "description":"Unique identifier of the category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CurrentSpend":{
            "type":"number",
            "description":"Sum of the current Amount of all award completed negotiations within the objective.",
            "nullable":true
        },
        "Description":{
            "maxLength":4000,
            "type":"string",
            "description":"Description of the objective.",
            "nullable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the objective ends.",
            "format":"date",
            "nullable":true
        },
        "Name":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the objective.",
            "nullable":true
        },
        "ObjectiveHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the objective.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectiveType":{
            "maxLength":30,
            "type":"string",
            "description":"Description of the objective type.",
            "nullable":true
        },
        "ProgramHeaderId":{
            "type":"integer",
            "description":"Unique identifier for the program header in the program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PurchasingCatFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates if the category associated with the program is purchasing category.",
            "nullable":true
        },
        "RemainingTargetSpend":{
            "type":"number",
            "description":"Value that indicates that target spend amount hasn't been allocated to the negotiation",
            "nullable":true
        },
        "RollUpFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates whether the savings and spend values of the objective's negotiations will be counted for program level spend and savings.",
            "nullable":true
        },
        "Savings":{
            "type":"number",
            "description":"Savings amount that the program is trying to achieve.",
            "nullable":true
        },
        "SavingsPercent":{
            "type":"number",
            "description":"Savings percentage that the program is trying to achieve.",
            "nullable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the objective starts.",
            "format":"date",
            "nullable":true
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"Description of the objective status.",
            "nullable":true
        },
        "TargetSpend":{
            "type":"number",
            "description":"Target spend that the program is trying to achieve.",
            "nullable":true
        },
        "TotalPlannedCurrentSpend":{
            "type":"number",
            "description":"Sum of all the negotiation current amounts of objectives.",
            "nullable":true
        },
        "TotalPlannedSavingGoalPercent":{
            "type":"number",
            "description":"Savings percentage that the program is trying to achieve.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "TotalPlannedCurrentSpend",
                    "TotalPlannedSavingGoal"
                ]
            }
        },
        "TotalPlannedTargetSpend":{
            "type":"number",
            "description":"Sum of Negotiation Target Spend for all the objectives.",
            "nullable":true
        },
        "sourcingProgramNegotiations":{
            "title":"Sourcing Program Objective Negotiations",
            "type":"array",
            "description":"Details about an organization's sourcing program and its associated negotiations.",
            "items":{
                "$ref":"#/components/schemas/sourcingPrograms-sourcingProgramObjectives-sourcingProgramNegotiations-item-patch-request"
            }
        }
    }
}

Nested Schema : Sourcing Program Objective Negotiations

Type: array

Title: Sourcing Program Objective Negotiations

Details about an organization's sourcing program and its associated negotiations.

Show Source

• Array of: object sourcingPrograms-sourcingProgramObjectives-sourcingProgramNegotiations-item-patch-request

{
    "title":"Sourcing Program Objective Negotiations",
    "type":"array",
    "description":"Details about an organization's sourcing program and its associated negotiations.",
    "items":{
        "$ref":"#/components/schemas/sourcingPrograms-sourcingProgramObjectives-sourcingProgramNegotiations-item-patch-request"
    }
}

Nested Schema : sourcingPrograms-sourcingProgramObjectives-sourcingProgramNegotiations-item-patch-request

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-item-response

Type: object

Show Source

• CategoryId: integer (int64)
  Indicates the unique identifier of category.
• CategoryName: string
  Read Only: true

  Maximum Length: 255

  Category name of the program.
• Comments: string
  Maximum Length: 4000

  Comments provided while creating the program.
• CurrencyCode: string
  Maximum Length: 15

  Base currency code in which the negotiation will be conducted.
• CurrentSpend: number
  Current spend for which the program is created.
• DisplayPhase: string
  Maximum Length: 255

  Description of the program phase.
• DisplayStatus: string
  Maximum Length: 255

  Description of the program status.
• EndDate: string (date)
  The date when the program ends.
• GlobalProgramFlag: boolean
  Maximum Length: 1

  Value that indicates if the program is global.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListName: string
  Maximum Length: 301

  List name of the person in the program.
• PersonId: integer (int64)
  Identifier of the person who created the program.
• PersonNameId: integer (int64)
  Read Only: true

  Unique identifier of the sourcing program owner.
• PhaseDisplayOrder: integer
  Read Only: true

  Sequence in which the program phase is displayed.
• ProcurementBUId: integer (int64)
  Unique identifier of the procurement business unit for which the program was created. It's populated only when the program isn't global.
• ProgramHeaderId: integer (int64)
  Value that uniquely identifies the program.
• ProgramPhase: string
  Maximum Length: 20

  Determines phase of the program.
• ProgramStatus: string
  Maximum Length: 30

  Determines status of the program.
• PurchasingCatFlag: boolean
  Maximum Length: 1

  Indicates whether the category associated with the program is purchasing category.
• RateDate: string (date)
  Conversion date for the selected rate type.
• RateType: string
  Maximum Length: 30

  Rate type selected for the program.
• Savings: number
  Savings amount that the program is trying to achieve.
• SavingsPercent: number
  Savings percentage that the program is trying to achieve.
• sourcingProgramMembers: array Sourcing Program Team Members
  Title: Sourcing Program Team Members

  Details about an organization's sourcing program and its associated team members.
• sourcingProgramObjectives: array Sourcing Program Objectives
  Title: Sourcing Program Objectives

  Details about an organization's sourcing program and its associated objectives.
• StartDate: string (date)
  Date when the program starts.
• Synopsis: string
  Maximum Length: 4000

  Program synopsis as defined by the user.
• TargetSpend: number
  Target spend that the program is trying to achieve.
• Title: string
  Maximum Length: 80

  Program title defined by the user.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "type":"integer",
            "description":"Indicates the unique identifier of category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CategoryName":{
            "maxLength":255,
            "type":"string",
            "description":"Category name of the program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Comments":{
            "maxLength":4000,
            "type":"string",
            "description":"Comments provided while creating the program.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Base currency code in which the negotiation will be conducted.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrentSpend":{
            "type":"number",
            "description":"Current spend for which the program is created.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayPhase":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the program phase.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the program status.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The date when the program ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalProgramFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates if the program is global.",
            "nullable":false,
            "x-queryable":true
        },
        "ListName":{
            "maxLength":301,
            "type":"string",
            "description":"List name of the person in the program.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Identifier of the person who created the program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonNameId":{
            "type":"integer",
            "description":"Unique identifier of the sourcing program owner.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PhaseDisplayOrder":{
            "type":"integer",
            "description":"Sequence in which the program phase is displayed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Unique identifier of the procurement business unit for which the program was created. It's populated only when the program isn't global.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramPhase":{
            "maxLength":20,
            "type":"string",
            "description":"Determines phase of the program.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProgramStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Determines status of the program.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PurchasingCatFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the category associated with the program is purchasing category.",
            "nullable":true,
            "x-queryable":true
        },
        "RateDate":{
            "type":"string",
            "description":"Conversion date for the selected rate type.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RateType":{
            "maxLength":30,
            "type":"string",
            "description":"Rate type selected for the program.",
            "nullable":true,
            "x-queryable":true
        },
        "Savings":{
            "type":"number",
            "description":"Savings amount that the program is trying to achieve.",
            "nullable":true,
            "x-queryable":true
        },
        "SavingsPercent":{
            "type":"number",
            "description":"Savings percentage that the program is trying to achieve.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the program starts.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Synopsis":{
            "maxLength":4000,
            "type":"string",
            "description":"Program synopsis as defined by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetSpend":{
            "type":"number",
            "description":"Target spend that the program is trying to achieve.",
            "nullable":true,
            "x-queryable":true
        },
        "Title":{
            "maxLength":80,
            "type":"string",
            "description":"Program title defined by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "sourcingProgramMembers":{
            "title":"Sourcing Program Team Members",
            "type":"array",
            "description":"Details about an organization's sourcing program and its associated team members.",
            "items":{
                "$ref":"#/components/schemas/sourcingPrograms-sourcingProgramMembers-item-response"
            }
        },
        "sourcingProgramObjectives":{
            "title":"Sourcing Program Objectives",
            "type":"array",
            "description":"Details about an organization's sourcing program and its associated objectives.",
            "items":{
                "$ref":"#/components/schemas/sourcingPrograms-sourcingProgramObjectives-item-response"
            }
        }
    }
}

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 : Sourcing Program Team Members

Type: array

Title: Sourcing Program Team Members

Details about an organization's sourcing program and its associated team members.

Show Source

• Array of: object sourcingPrograms-sourcingProgramMembers-item-response

{
    "title":"Sourcing Program Team Members",
    "type":"array",
    "description":"Details about an organization's sourcing program and its associated team members.",
    "items":{
        "$ref":"#/components/schemas/sourcingPrograms-sourcingProgramMembers-item-response"
    }
}

Nested Schema : Sourcing Program Objectives

Type: array

Title: Sourcing Program Objectives

Details about an organization's sourcing program and its associated objectives.

Show Source

• Array of: object sourcingPrograms-sourcingProgramObjectives-item-response

{
    "title":"Sourcing Program Objectives",
    "type":"array",
    "description":"Details about an organization's sourcing program and its associated objectives.",
    "items":{
        "$ref":"#/components/schemas/sourcingPrograms-sourcingProgramObjectives-item-response"
    }
}

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."
        }
    }
}

Nested Schema : sourcingPrograms-sourcingProgramMembers-item-response

Type: object

Show Source

• AccessType: string
  Read Only: true

  Maximum Length: 255

  Determines the access level of the team member.
• AccessTypeCode: string
  Maximum Length: 30

  Value that identifies the agent access for the lookup code. Valid value is MANAGE_NEGOTIATIONS.
• DisplayName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Display name of the program team member.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemberType: string
  Maximum Length: 1

  Value that identifies the program team member type.
• Note: string
  Maximum Length: 4000

  Note entered for the program team member.
• 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.
• PersonId: integer (int64)
  Value that uniquely identifies the program team member name.
• PersonNameId: integer (int64)
  Read Only: true

  Value that uniquely identifies the name of the program team member.
• ProgramHeaderId: integer (int64)
  Unique identifier for the program header in the program.
• TeamMemberId: integer (int64)
  Value that uniquely identifies the program team member name.

{
    "type":"object",
    "properties":{
        "AccessType":{
            "maxLength":255,
            "type":"string",
            "description":"Determines the access level of the team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the agent access for the lookup code. Valid value is MANAGE_NEGOTIATIONS.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Display name of the program team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberType":{
            "maxLength":1,
            "type":"string",
            "description":"Value that identifies the program team member type.",
            "nullable":true,
            "x-queryable":true
        },
        "Note":{
            "maxLength":4000,
            "type":"string",
            "description":"Note entered for the program team member.",
            "nullable":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
        },
        "PersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the program team member name.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonNameId":{
            "type":"integer",
            "description":"Value that uniquely identifies the name of the program team member.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "TeamMemberId":{
            "type":"integer",
            "description":"Value that uniquely identifies the program team member name.",
            "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 : sourcingPrograms-sourcingProgramObjectives-item-response

Type: object

Show Source

• CategoryId: integer (int64)
  Unique identifier of the category.
• CreationDate: string (date-time)
  Read Only: true

  Date and time the objective row was created.
• CurrentSpend: number
  Sum of the current Amount of all award completed negotiations within the objective.
• Description: string
  Maximum Length: 4000

  Description of the objective.
• EndDate: string (date)
  Date when the objective ends.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Maximum Length: 80

  Name of the objective.
• ObjectiveHeaderId: integer (int64)
  Value that uniquely identifies the objective.
• ObjectiveType: string
  Maximum Length: 30

  Description of the objective type.
• ProgramHeaderId: integer (int64)
  Unique identifier for the program header in the program.
• PurchasingCatFlag: boolean
  Maximum Length: 1

  Value that indicates if the category associated with the program is purchasing category.
• RemainingTargetSpend: number
  Value that indicates that target spend amount hasn't been allocated to the negotiation
• RollUpFlag: boolean
  Maximum Length: 1

  Value that indicates whether the savings and spend values of the objective's negotiations will be counted for program level spend and savings.
• Savings: number
  Savings amount that the program is trying to achieve.
• SavingsPercent: number
  Savings percentage that the program is trying to achieve.
• sourcingProgramNegotiations: array Sourcing Program Objective Negotiations
  Title: Sourcing Program Objective Negotiations

  Details about an organization's sourcing program and its associated negotiations.
• StartDate: string (date)
  Date when the objective starts.
• Status: string
  Maximum Length: 30

  Description of the objective status.
• TargetSpend: number
  Target spend that the program is trying to achieve.
• TotalPlannedCurrentSpend: number
  Sum of all the negotiation current amounts of objectives.
• TotalPlannedSavingGoal: number
  Read Only: true

  Planned Savings Goal of all award completed negotiations within the objective.
• TotalPlannedSavingGoalPercent: number
  Savings percentage that the program is trying to achieve.
• TotalPlannedTargetSpend: number
  Sum of Negotiation Target Spend for all the objectives.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "type":"integer",
            "description":"Unique identifier of the category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time the objective row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentSpend":{
            "type":"number",
            "description":"Sum of the current Amount of all award completed negotiations within the objective.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":4000,
            "type":"string",
            "description":"Description of the objective.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the objective ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the objective.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectiveHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the objective.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectiveType":{
            "maxLength":30,
            "type":"string",
            "description":"Description of the objective type.",
            "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
        },
        "PurchasingCatFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates if the category associated with the program is purchasing category.",
            "nullable":true,
            "x-queryable":true
        },
        "RemainingTargetSpend":{
            "type":"number",
            "description":"Value that indicates that target spend amount hasn't been allocated to the negotiation",
            "nullable":true,
            "x-queryable":true
        },
        "RollUpFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates whether the savings and spend values of the objective's negotiations will be counted for program level spend and savings.",
            "nullable":true,
            "x-queryable":true
        },
        "Savings":{
            "type":"number",
            "description":"Savings amount that the program is trying to achieve.",
            "nullable":true,
            "x-queryable":true
        },
        "SavingsPercent":{
            "type":"number",
            "description":"Savings percentage that the program is trying to achieve.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the objective starts.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"Description of the objective status.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetSpend":{
            "type":"number",
            "description":"Target spend that the program is trying to achieve.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalPlannedCurrentSpend":{
            "type":"number",
            "description":"Sum of all the negotiation current amounts of objectives.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalPlannedSavingGoal":{
            "type":"number",
            "description":"Planned Savings Goal of all award completed negotiations within the objective.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPlannedSavingGoalPercent":{
            "type":"number",
            "description":"Savings percentage that the program is trying to achieve.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "TotalPlannedCurrentSpend",
                    "TotalPlannedSavingGoal"
                ]
            },
            "x-queryable":true
        },
        "TotalPlannedTargetSpend":{
            "type":"number",
            "description":"Sum of Negotiation Target Spend for all the objectives.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "sourcingProgramNegotiations":{
            "title":"Sourcing Program Objective Negotiations",
            "type":"array",
            "description":"Details about an organization's sourcing program and its associated negotiations.",
            "items":{
                "$ref":"#/components/schemas/sourcingPrograms-sourcingProgramObjectives-sourcingProgramNegotiations-item-response"
            }
        }
    }
}

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 : Sourcing Program Objective Negotiations

Type: array

Title: Sourcing Program Objective Negotiations

Details about an organization's sourcing program and its associated negotiations.

Show Source

• Array of: object sourcingPrograms-sourcingProgramObjectives-sourcingProgramNegotiations-item-response

{
    "title":"Sourcing Program Objective Negotiations",
    "type":"array",
    "description":"Details about an organization's sourcing program and its associated negotiations.",
    "items":{
        "$ref":"#/components/schemas/sourcingPrograms-sourcingProgramObjectives-sourcingProgramNegotiations-item-response"
    }
}

Nested 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"
    }
}

Links

sourcingProgramMembers

Operation: /fscmRestApi/resources/11.13.18.05/sourcingPrograms/{ProgramHeaderId}/child/sourcingProgramMembers

Parameters:

• ProgramHeaderId: $request.path.ProgramHeaderId

Details about an organization's sourcing program and its associated team members.

sourcingProgramObjectives

Operation: /fscmRestApi/resources/11.13.18.05/sourcingPrograms/{ProgramHeaderId}/child/sourcingProgramObjectives

Parameters:

• ProgramHeaderId: $request.path.ProgramHeaderId

Details about an organization's sourcing program and its associated objectives.

Back to Top