Jump to

• Request
• Response

Add one sourcing program objective

post

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

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

• attachments: array Sourcing Program Objectives Attachments
  Title: Sourcing Program Objectives Attachments

  Attachments associated with a sourcing program objective.
• CategoryId: integer (int64)
  Unique identifier of the category.
• Comments: string
  Maximum Length: 4000

  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.
• ObjectiveDisplayStatus: string
  Maximum Length: 255

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

  Description of the objective type.
• PersonId: integer (int64)
  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":[
        "ProgramHeaderId"
    ],
    "type":"object",
    "properties":{
        "CategoryId":{
            "type":"integer",
            "description":"Unique identifier of the category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Comments":{
            "maxLength":4000,
            "type":"string",
            "description":"Unique identifier of the category.",
            "nullable":true
        },
        "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
        },
        "ObjectiveDisplayStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Display status of the objective.",
            "nullable":true
        },
        "ObjectiveHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the objective.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ObjectiveType":{
            "maxLength":30,
            "type":"string",
            "description":"Description of the objective type.",
            "nullable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Description of the objective type.",
            "format":"int64",
            "nullable":true,
            "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
            }
        },
        "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
        },
        "attachments":{
            "title":"Sourcing Program Objectives Attachments",
            "type":"array",
            "description":"Attachments associated with a sourcing program objective.",
            "items":{
                "$ref":"#/components/schemas/sourcingPrograms-sourcingProgramObjectives-attachments-item-post-request"
            }
        },
        "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-post-request"
            }
        }
    }
}

Nested Schema : Sourcing Program Objectives Attachments

Type: array

Title: Sourcing Program Objectives Attachments

Attachments associated with a sourcing program objective.

Show Source

• Array of: object sourcingPrograms-sourcingProgramObjectives-attachments-item-post-request

{
    "title":"Sourcing Program Objectives Attachments",
    "type":"array",
    "description":"Attachments associated with a sourcing program objective.",
    "items":{
        "$ref":"#/components/schemas/sourcingPrograms-sourcingProgramObjectives-attachments-item-post-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 schema

{
    "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-post-request"
    }
}

Nested Schema : sourcingPrograms-sourcingProgramObjectives-attachments-item-post-request

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Unique identifier of the asynchronous tracker.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category name of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment file is shared in the content repository. Contains one of these values: true or false. If true, then the file is shared in the content repository. If false, then the file isn't shared in the content repository. This attribute doesn't have a default value.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Code that identifies the attachment data type.
• Description: string
  Title: Description

  Maximum Length: 255

  Details about an organization's sourcing objectives and the associated negotiations.
• DmDocumentId: string
  Maximum Length: 255

  Unique identifier of the attachment document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path where the attachment is stored.
• DmVersionNumber: string
  Maximum Length: 255

  Version number of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  Information used to download the attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Code that indicates the attachment error status.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error message that indicates the attachment upload status.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The date when the attachment expires.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment file.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Details about an organization's sourcing objectives and the associated negotiations.
• FileUrl: string
  Title: File Url

  URL of the attachment file.
• PostProcessingAction: string
  Title: PostProcessingAction

  Action to be performed on the attachment after it's uploaded.
• Title: string
  Title: Title

  Details about an organization's sourcing objectives and the associated negotiations.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the uploaded file.
• UploadedFileLength: integer
  Title: File Size

  File size of the uploaded attachment.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the uploaded file.
• UploadedText: string
  Title: Uploaded Text

  Text of the uploaded attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  Uniform resource identifier of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL of the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Unique identifier of the asynchronous tracker.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment file is shared in the content repository. Contains one of these values: true or false. If true, then the file is shared in the content repository. If false, then the file isn't shared in the content repository. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the attachment data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Details about an organization's sourcing objectives and the associated negotiations.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the attachment document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Folder path where the attachment is stored.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"Information used to download the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Code that indicates the attachment error status.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error message that indicates the attachment upload status.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the attachment expires.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Details about an organization's sourcing objectives and the associated negotiations.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"Action to be performed on the attachment after it's uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Details about an organization's sourcing objectives and the associated negotiations.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the uploaded file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"File size of the uploaded attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the uploaded file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the uploaded attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"Uniform resource identifier of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• AuctionHeaderId: integer (int64)
  Value that uniquely identifies the negotiation.
• AwardAmount: number
  Title: Negotiated Award Amount

  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.
• 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":{
            "title":"Negotiated Award Amount",
            "type":"number",
            "description":"Award amount identified in the objective.",
            "nullable":true
        },
        "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,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "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-item-response

Type: object

Show Source

• AssignedTo: string
  Read Only: true

  Maximum Length: 240

  User assigned to the sourcing program objective.
• attachments: array Sourcing Program Objectives Attachments
  Title: Sourcing Program Objectives Attachments

  Attachments associated with a sourcing program objective.
• CategoryId: integer (int64)
  Unique identifier of the category.
• CategoryNameDisplay: string
  Read Only: true

  Maximum Length: 2400

  Name of the category of the sourcing program objective.
• Comments: string
  Maximum Length: 4000

  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.
• NegotiatedAwardAmount: number
  Read Only: true

  Name of the objective.
• NegotiatedSavings: number
  Read Only: true

  Negotiated savings amount for the sourcing program objective.
• NegotiatedSavingsPercent: number
  Read Only: true

  Percentage of negotiated savings for the sourcing program objective.
• NegotiationCurrentSpend: number
  Read Only: true

  Current spend defined in the sourcing program objective.
• NegotiationSavingsGoal: number
  Read Only: true

  Savings goal for the negotiation.
• NegotiationSavingsGoalPercent: number
  Read Only: true

  Percentage savings goal for the negotiation.
• NegotiationTargetSpend: number
  Read Only: true

  Target spend defined in the sourcing program objective.
• ObjectiveDisplayStatus: string
  Maximum Length: 255

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

  Description of the objective type.
• ObjectiveTypeDisplay: string
  Read Only: true

  Maximum Length: 255

  Type of the sourcing program objective.
• PersonId: integer (int64)
  Description of the objective type.
• PlannedCurrentSpend: number
  Read Only: true

  Planned current spend defined for the sourcing program objective.
• 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.
• SavingsDeviation: number
  Read Only: true

  Difference between the target savings and the actual savings for the sourcing program objective.
• 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":{
        "AssignedTo":{
            "maxLength":240,
            "type":"string",
            "description":"User assigned to the sourcing program objective.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryId":{
            "type":"integer",
            "description":"Unique identifier of the category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CategoryNameDisplay":{
            "maxLength":2400,
            "type":"string",
            "description":"Name of the category of the sourcing program objective.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Comments":{
            "maxLength":4000,
            "type":"string",
            "description":"Unique identifier of the category.",
            "nullable":true,
            "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
        },
        "NegotiatedAwardAmount":{
            "type":"number",
            "description":"Name of the objective.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NegotiatedSavings":{
            "type":"number",
            "description":"Negotiated savings amount for the sourcing program objective.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NegotiatedSavingsPercent":{
            "type":"number",
            "description":"Percentage of negotiated savings for the sourcing program objective.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NegotiationCurrentSpend":{
            "type":"number",
            "description":"Current spend defined in the sourcing program objective.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NegotiationSavingsGoal":{
            "type":"number",
            "description":"Savings goal for the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NegotiationSavingsGoalPercent":{
            "type":"number",
            "description":"Percentage savings goal for the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NegotiationTargetSpend":{
            "type":"number",
            "description":"Target spend defined in the sourcing program objective.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectiveDisplayStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Display status 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,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ObjectiveType":{
            "maxLength":30,
            "type":"string",
            "description":"Description of the objective type.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectiveTypeDisplay":{
            "maxLength":255,
            "type":"string",
            "description":"Type of the sourcing program objective.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Description of the objective type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlannedCurrentSpend":{
            "type":"number",
            "description":"Planned current spend defined for the sourcing program objective.",
            "nullable":true,
            "readOnly":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
        },
        "SavingsDeviation":{
            "type":"number",
            "description":"Difference between the target savings and the actual savings for the sourcing program objective.",
            "nullable":true,
            "readOnly":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
        },
        "attachments":{
            "title":"Sourcing Program Objectives Attachments",
            "type":"array",
            "description":"Attachments associated with a sourcing program objective.",
            "items":{
                "$ref":"#/components/schemas/sourcingPrograms-sourcingProgramObjectives-attachments-item-response"
            }
        },
        "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 : Sourcing Program Objectives Attachments

Type: array

Title: Sourcing Program Objectives Attachments

Attachments associated with a sourcing program objective.

Show Source

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

{
    "title":"Sourcing Program Objectives Attachments",
    "type":"array",
    "description":"Attachments associated with a sourcing program objective.",
    "items":{
        "$ref":"#/components/schemas/sourcingPrograms-sourcingProgramObjectives-attachments-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-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Unique identifier of the asynchronous tracker.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category name of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment file is shared in the content repository. Contains one of these values: true or false. If true, then the file is shared in the content repository. If false, then the file isn't shared in the content repository. This attribute doesn't have a default value.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  Details about an organization's sourcing objectives and the associated negotiations.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  User who created the attachment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the attachment was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Code that identifies the attachment data type.
• Description: string
  Title: Description

  Maximum Length: 255

  Details about an organization's sourcing objectives and the associated negotiations.
• DmDocumentId: string
  Maximum Length: 255

  Unique identifier of the attachment document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path where the attachment is stored.
• DmVersionNumber: string
  Maximum Length: 255

  Version number of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  Information used to download the attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Code that indicates the attachment error status.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error message that indicates the attachment upload status.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The date when the attachment expires.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment file.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Details about an organization's sourcing objectives and the associated negotiations.
• FileUrl: string
  Title: File Url

  URL of the attachment file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  Web image of the attachment file.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the attachment was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  Details about an organization's sourcing objectives and the associated negotiations.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  User name used to update the attachment for the sourcing program objective.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  Action to be performed on the attachment after it's uploaded.
• Title: string
  Title: Title

  Details about an organization's sourcing objectives and the associated negotiations.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the uploaded file.
• UploadedFileLength: integer
  Title: File Size

  File size of the uploaded attachment.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the uploaded file.
• UploadedText: string
  Title: Uploaded Text

  Text of the uploaded attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  Uniform resource identifier of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL of the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  User name associated with the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Unique identifier of the asynchronous tracker.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment file is shared in the content repository. Contains one of these values: true or false. If true, then the file is shared in the content repository. If false, then the file isn't shared in the content repository. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"Details about an organization's sourcing objectives and the associated negotiations.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the attachment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the attachment data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Details about an organization's sourcing objectives and the associated negotiations.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the attachment document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Folder path where the attachment is stored.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"Information used to download the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Code that indicates the attachment error status.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error message that indicates the attachment upload status.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the attachment expires.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Details about an organization's sourcing objectives and the associated negotiations.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"Web image of the attachment file.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the attachment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"Details about an organization's sourcing objectives and the associated negotiations.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"User name used to update the attachment for the sourcing program objective.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"Action to be performed on the attachment after it's uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Details about an organization's sourcing objectives and the associated negotiations.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the uploaded file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"File size of the uploaded attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the uploaded file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the uploaded attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"Uniform resource identifier of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"User name associated with the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "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."
        }
    }
}

Nested Schema : sourcingPrograms-sourcingProgramObjectives-sourcingProgramNegotiations-item-response

Type: object

Show Source

• AuctionHeaderId: integer (int64)
  Value that uniquely identifies the negotiation.
• AwardAmount: number
  Title: Negotiated Award Amount

  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.
• 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":{
            "title":"Negotiated Award Amount",
            "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
        },
        "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,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "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

attachments

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

Parameters:

• ObjectiveHeaderId: $request.path.ObjectiveHeaderId
• ProgramHeaderId: $request.path.ProgramHeaderId

Attachments associated with a sourcing program objective.

sourcingProgramNegotiations

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

Parameters:

• ObjectiveHeaderId: $request.path.ObjectiveHeaderId
• ProgramHeaderId: $request.path.ProgramHeaderId

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

Back to Top