Jump to

• Request
• Response
• Examples

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

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

  Attachments associated with a sourcing program objective.
• 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.
• DFF: array DFF
• EndDate: string (date)
  The date when the program ends.
• GlobalProgramFlag: boolean
  Maximum Length: 1

  Value that indicates if the program is global.
• 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.
• 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
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sourcingPrograms-DFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "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
        },
        "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
            }
        },
        "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
        },
        "attachments":{
            "title":"Sourcing Program Attachments",
            "type":"array",
            "description":"Attachments associated with a sourcing program objective.",
            "items":{
                "$ref":"#/components/schemas/sourcingPrograms-attachments-item-patch-request"
            }
        },
        "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 Attachments

Type: array

Title: Sourcing Program Attachments

Attachments associated with a sourcing program objective.

Show Source

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

{
    "title":"Sourcing Program Attachments",
    "type":"array",
    "description":"Attachments associated with a sourcing program objective.",
    "items":{
        "$ref":"#/components/schemas/sourcingPrograms-attachments-item-patch-request"
    }
}

Nested Schema : DFF

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sourcingPrograms-DFF-item-patch-request"
    },
    "x-cardinality":"1"
}

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-attachments-item-patch-request

Type: object

Show Source

• 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":{
        "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 : sourcingPrograms-DFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Attribute

  Maximum Length: 30

  Context Attribute
• __FLEX_Context_DisplayValue: string
  Title: Context Attribute

  Context Attribute
• ProgramHeaderId: integer (int64)

{
    "type":"object",
    "properties":{
        "ProgramHeaderId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context":{
            "title":"Context Attribute",
            "maxLength":30,
            "type":"string",
            "description":"Context Attribute",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Attribute",
            "type":"string",
            "description":"Context Attribute",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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.
• 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
        },
        "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,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        }
    }
}

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

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.
• ObjectiveType: string
  Maximum Length: 30

  Description of the objective type.
• PersonId: integer (int64)
  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.
• 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
            }
        },
        "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
        },
        "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-patch-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-patch-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-patch-request

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

Type: object

Show Source

• 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":{
        "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 : sourcingPrograms-sourcingProgramObjectives-sourcingProgramNegotiations-item-patch-request

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

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

  Attachments associated with a sourcing program objective.
• BaseLineNotAllocatedToObjective: number
  Read Only: true

  Baseline amount that isn't allocated to objectives in a sourcing program.
• CanDeleteFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the sourcing program can be deleted. Contains one of the following values: true or false. If true, then you can delete the sourcing program. If false, then you can't delete the sourcing program. This attribute doesn't have a default value.
• CanEditFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the sourcing program can be edited. Contains one of the following values: true or false. If true, then you can edit the sourcing program. If false, then you can't edit the sourcing program. This attribute doesn't have a default value.
• CanEditMonitorActionFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether a user can edit the program by using actions on the monitor. Contains one of the following values: true or false. If true, then editing the monitor action is allowed. If false, then editing the monitor action isn't allowed. This attribute doesn't have a default value.
• CanLaunchFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the sourcing program can be launched. Contains one of the following values: true or false. If true, then you can start the sourcing program. If false, then you can't start the sourcing program. This attribute doesn't have a default value.
• CanMonitorFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the sourcing program can be monitored. Contains one of the following values: true or false. If true, then you can monitor the sourcing program. If false, then you can't monitor the sourcing program. This attribute doesn't have a default value.
• CanUpdateObjectiveResultsFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether objective results can be updated. Contains one of the following values: true or false. If true, then objective results can be updated. If false, then objective results can't be updated. This attribute doesn't have a default value.
• 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.
• CurrencyName: string
  Title: Currency Name

  Read Only: true

  Maximum Length: 80

  Base currency code in which the negotiation will be conducted.
• CurrentSpend: number
  Current spend for which the program is created.
• DFF: array DFF
• DisplayPhase: string
  Read Only: true

  Maximum Length: 255

  Description of the program phase.
• DisplayStatus: string
  Read Only: true

  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
  Read Only: true

  Maximum Length: 301

  List name of the person in the program.
• NegotiatedSavings: number
  Read Only: true

  Amount saved through negotiation for the sourcing program.
• NegotiatedSavingsPercent: number
  Read Only: true

  Amount saved through negotiation for the sourcing program.
• NegotiationSavingsGoal: number
  Read Only: true

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

  Savings goal for the negotiation.
• 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.
• PlannedTargetSpend: number
  Read Only: true

  Planned target spend for the sourcing program.
• Precision: integer (int32)
  Title: Precision

  Read Only: true

  Planned target spend for the sourcing 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.
• RemainingTargetSpend: number
  Read Only: true

  Remaining target spend for the sourcing program.
• Savings: number
  Savings amount that the program is trying to achieve.
• SavingsDeviation: number
  Read Only: true

  Difference between the actual savings and the planned savings for the sourcing program.
• 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":{
        "BaseLineNotAllocatedToObjective":{
            "type":"number",
            "description":"Baseline amount that isn't allocated to objectives in a sourcing program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CanDeleteFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the sourcing program can be deleted. Contains one of the following values: true or false. If true, then you can delete the sourcing program. If false, then you can't delete the sourcing program. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CanEditFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the sourcing program can be edited. Contains one of the following values: true or false. If true, then you can edit the sourcing program. If false, then you can't edit the sourcing program. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CanEditMonitorActionFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a user can edit the program by using actions on the monitor. Contains one of the following values: true or false. If true, then editing the monitor action is allowed. If false, then editing the monitor action isn't allowed. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CanLaunchFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the sourcing program can be launched. Contains one of the following values: true or false. If true, then you can start the sourcing program. If false, then you can't start the sourcing program. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CanMonitorFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the sourcing program can be monitored. Contains one of the following values: true or false. If true, then you can monitor the sourcing program. If false, then you can't monitor the sourcing program. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CanUpdateObjectiveResultsFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether objective results can be updated. Contains one of the following values: true or false. If true, then objective results can be updated. If false, then objective results can't be updated. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "CurrencyName":{
            "title":"Currency Name",
            "maxLength":80,
            "type":"string",
            "description":"Base currency code in which the negotiation will be conducted.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentSpend":{
            "type":"number",
            "description":"Current spend for which the program is created.",
            "nullable":true,
            "x-queryable":true
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sourcingPrograms-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "DisplayPhase":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the program phase.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the program status.",
            "nullable":true,
            "readOnly":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,
            "readOnly":true,
            "x-queryable":true
        },
        "NegotiatedSavings":{
            "type":"number",
            "description":"Amount saved through negotiation for the sourcing program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NegotiatedSavingsPercent":{
            "type":"number",
            "description":"Amount saved through negotiation for the sourcing program.",
            "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":"Savings goal for the negotiation.",
            "nullable":true,
            "readOnly":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
        },
        "PlannedTargetSpend":{
            "type":"number",
            "description":"Planned target spend for the sourcing program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Precision":{
            "title":"Precision",
            "type":"integer",
            "description":"Planned target spend for the sourcing program.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":1
            },
            "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,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "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
        },
        "RemainingTargetSpend":{
            "type":"number",
            "description":"Remaining target spend for the sourcing program.",
            "nullable":true,
            "readOnly":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 actual savings and the planned savings for the sourcing program.",
            "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 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
        },
        "attachments":{
            "title":"Sourcing Program Attachments",
            "type":"array",
            "description":"Attachments associated with a sourcing program objective.",
            "items":{
                "$ref":"#/components/schemas/sourcingPrograms-attachments-item-response"
            }
        },
        "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 : Sourcing Program Attachments

Type: array

Title: Sourcing Program Attachments

Attachments associated with a sourcing program objective.

Show Source

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

{
    "title":"Sourcing Program Attachments",
    "type":"array",
    "description":"Attachments associated with a sourcing program objective.",
    "items":{
        "$ref":"#/components/schemas/sourcingPrograms-attachments-item-response"
    }
}

Nested Schema : DFF

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sourcingPrograms-DFF-item-response"
    },
    "x-cardinality":"1"
}

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 : sourcingPrograms-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

  Name of the 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

  Details about an organization's sourcing objectives and the associated negotiations.
• 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":"Name of the 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":"Details about an organization's sourcing objectives and the associated negotiations.",
            "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-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Attribute

  Maximum Length: 30

  Context Attribute
• __FLEX_Context_DisplayValue: string
  Title: Context Attribute

  Context Attribute
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProgramHeaderId: integer (int64)

{
    "type":"object",
    "properties":{
        "ProgramHeaderId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Attribute",
            "maxLength":30,
            "type":"string",
            "description":"Context Attribute",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Attribute",
            "type":"string",
            "description":"Context Attribute",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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-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.
• 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
        },
        "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,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : 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 : 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

DFF

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

Parameters:

• ProgramHeaderId: $request.path.ProgramHeaderId

LaunchProgram

Operation: /fscmRestApi/resources/11.13.18.05/sourcingPrograms/{ProgramHeaderId}/action/LaunchProgram

Parameters:

• ProgramHeaderId: $request.path.ProgramHeaderId

Launches a sourcing program.

ValidateProgramObjective

Operation: /fscmRestApi/resources/11.13.18.05/sourcingPrograms/{ProgramHeaderId}/action/ValidateProgramObjective

Parameters:

• ProgramHeaderId: $request.path.ProgramHeaderId

Validates a sourcing program objective.

attachments

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

Parameters:

• ProgramHeaderId: $request.path.ProgramHeaderId

Details about attachments associated with a sourcing program.

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

Examples

This example describes how to update one sourcing program.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/sourcingPrograms/ProgramHeaderId"

For example:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/sourcingPrograms/300100121470199"

Example Response Body

The following example includes the contents of the response body in JSON format:

{
"ProgramHeaderId": "300100121470199",
"ProgramPhase": "IN_PROGRESS",
"Savings": "15000",
"SavingsPercent": "0.15",
"SavingsDeviation": "0",
"NegotiatedSavings": "0",
"NegotiationSavingsGoal": "0",
"NegotiatedSavingsPercent": "0",
"NegotiationSavingsGoalPercent": "0",
"BaseLineNotAllocatedToObjective": "0",
"PlannedTargetSpend": "28000",
"RemainingTargetSpend": "57000",
"StartDate": "2017-07-27",
"Synopsis": "Need to achieve higher savings on IT services spend",
"TargetSpend": "85000",
"Title": "PONSPG13001 1501150844",
"RateType": "Corporate",
"RateDate": "2017-07-27",
"PurchasingCatFlag": false,
"ProgramStatus": "GOALS_MET",
"ProcurementBUId": null,
"PersonId": "300100037430652",
"CurrencyCode": "USD",
"CurrentSpend": "100000",
"Comments": "Base line data is from CFO's office",
"CategoryId": "300100038634276",
"EndDate": "2017-08-26",
"GlobalProgramFlag": true,
"CategoryName": "IT",
"DisplayPhase": "In progress",
"DisplayStatus": "At risk",
"ListName": "PRC PON00007",
"PersonNameId": "300100037430653",
"PhaseDisplayOrder": "2",
"CurrencyName": "US Dollar",
"Precision": 2,
"@context": {
"key": "300100121470199",
"headers": {
"ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000778"
},
"links": [
{
"rel": "self",
"href": "http://mumbai633155.bom2.fusionappsdbom1.oraclevcn.com:7013/fscmRestApi/resources/11.13.18.05/sourcingPrograms/300100121470199",
"name": "sourcingPrograms",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://mumbai633155.bom2.fusionappsdbom1.oraclevcn.com:7013/fscmRestApi/resources/11.13.18.05/sourcingPrograms/300100121470199",
"name": "sourcingPrograms",
"kind": "item"
},
{
"rel": "child",
"href": "http://mumbai633155.bom2.fusionappsdbom1.oraclevcn.com:7013/fscmRestApi/resources/11.13.18.05/sourcingPrograms/300100121470199/child/DFF",
"name": "DFF",
"kind": "collection"
},
{
"rel": "child",
"href": "http://mumbai633155.bom2.fusionappsdbom1.oraclevcn.com:7013/fscmRestApi/resources/11.13.18.05/sourcingPrograms/300100121470199/child/attachments",
"name": "attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "http://mumbai633155.bom2.fusionappsdbom1.oraclevcn.com:7013/fscmRestApi/resources/11.13.18.05/sourcingPrograms/300100121470199/child/sourcingProgramMembers",
"name": "sourcingProgramMembers",
"kind": "collection"
},
{
"rel": "child",
"href": "http://mumbai633155.bom2.fusionappsdbom1.oraclevcn.com:7013/fscmRestApi/resources/11.13.18.05/sourcingPrograms/300100121470199/child/sourcingProgramObjectives",
"name": "sourcingProgramObjectives",
"kind": "collection"
}
]
}
}

Back to Top