Jump to

• Request
• Response
• Examples

Create a partner program

post

/crmRestApi/resources/11.13.18.05/partnerPrograms

Request

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• EndDateActive: string (date)
  Title: End Date

  The date when the partner program ends.
• PartnerProgramCountries: array Countries
  Title: Countries

  The countries resource is used to view, create, update, and delete the countries associated with partner programs. The countries resource is used to determine the scope of availability of partner programs in specific countries.
• PartnerProgramId: integer
  Title: Program ID

  The system-generated unique identifier and primary key of the partner program.
• ProgramBenefitDetails: array Program Benefit Details
  Title: Program Benefit Details

  The program benefit details resource is used to view, create, update, and delete the program benefits added to a partner program.
• ProgramDescription: string
  Title: Description

  Maximum Length: 1000

  The text describing the program.
• ProgramManagerId: integer
  Title: Program Manager ID

  The unique identifier for the owner of the partner program.
• ProgramManagerName: string
  Title: Owner

  Maximum Length: 360

  The name of the owner/manager of the partner program.
• ProgramName(required): string
  Title: Name

  Maximum Length: 150

  The name of the partner program.
• ProgramNumber: string
  Title: Program Number

  Maximum Length: 30

  The alternate key identifier generated for each program.
• ProgramTiers: array Tiers
  Title: Tiers

  The partner program tiers resource is used to view, create, update, and delete the tiers for a given program. Partner programs can be arranged into tiers and assigned to partners based on their level of contribution to the business.
• ProgramType(required): string
  Title: Type

  Maximum Length: 30

  The type of partner program. For example, Reseller or Go-to-Market.
• StartDateActive: string (date)
  Title: Start Date

  The date when the partner program starts.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: D

  The code indicating the status of the program. For example, Draft, Failed, Published, Rejected, Pending, Terminatedm or Unpublished. A list of valid values is defined in the lookup ZPM_PROGRAM_STATUS .

{
    "required":[
        "ProgramName",
        "ProgramType"
    ],
    "type":"object",
    "properties":{
        "ProgramTiers":{
            "title":"Tiers",
            "type":"array",
            "description":"The partner program tiers resource is used to view, create, update, and delete the tiers for a given program. Partner programs can be arranged into tiers and assigned to partners based on their level of contribution to the business.",
            "items":{
                "$ref":"#/components/schemas/partnerPrograms-ProgramTiers-item-post-request"
            }
        },
        "PartnerProgramId":{
            "title":"Program ID",
            "type":"integer",
            "description":"The system-generated unique identifier and primary key of the partner program.",
            "nullable":false
        },
        "ProgramBenefitDetails":{
            "title":"Program Benefit Details",
            "type":"array",
            "description":"The program benefit details resource is used to view, create, update, and delete the program benefits added to a partner program.",
            "items":{
                "$ref":"#/components/schemas/partnerPrograms-ProgramBenefitDetails-item-post-request"
            }
        },
        "ProgramName":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the partner program.",
            "nullable":false
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the status of the program. For example, Draft, Failed, Published, Rejected, Pending, Terminatedm or Unpublished. A list of valid values is defined in the lookup ZPM_PROGRAM_STATUS .",
            "nullable":false,
            "default":"D",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/partnerPrograms-Attachments-item-post-request"
            }
        },
        "ProgramManagerId":{
            "title":"Program Manager ID",
            "type":"integer",
            "description":"The unique identifier for the owner of the partner program.",
            "nullable":false,
            "x-queryable":false
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the partner program starts.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "controlType":"date"
            }
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the partner program ends.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "controlType":"date"
            }
        },
        "ProgramDescription":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The text describing the program.",
            "nullable":true
        },
        "PartnerProgramCountries":{
            "title":"Countries",
            "type":"array",
            "description":"The countries resource is used to view, create, update, and delete the countries associated with partner programs. The countries resource is used to determine the scope of availability of partner programs in specific countries.",
            "items":{
                "$ref":"#/components/schemas/partnerPrograms-PartnerProgramCountries-item-post-request"
            }
        },
        "ProgramNumber":{
            "title":"Program Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier generated for each program.",
            "nullable":false
        },
        "ProgramManagerName":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the owner/manager of the partner program.",
            "nullable":false,
            "x-hints":{
                "controlType":"input_text_lov"
            }
        },
        "ProgramType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of partner program. For example, Reseller or Go-to-Market.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object partnerPrograms-Attachments-item-post-request

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/partnerPrograms-Attachments-item-post-request"
    }
}

Nested Schema : Countries

Type: array

Title: Countries

The countries resource is used to view, create, update, and delete the countries associated with partner programs. The countries resource is used to determine the scope of availability of partner programs in specific countries.

Show Source

• Array of: object partnerPrograms-PartnerProgramCountries-item-post-request

{
    "title":"Countries",
    "type":"array",
    "description":"The countries resource is used to view, create, update, and delete the countries associated with partner programs. The countries resource is used to determine the scope of availability of partner programs in specific countries.",
    "items":{
        "$ref":"#/components/schemas/partnerPrograms-PartnerProgramCountries-item-post-request"
    }
}

Nested Schema : Program Benefit Details

Type: array

Title: Program Benefit Details

The program benefit details resource is used to view, create, update, and delete the program benefits added to a partner program.

Show Source

• Array of: object partnerPrograms-ProgramBenefitDetails-item-post-request

{
    "title":"Program Benefit Details",
    "type":"array",
    "description":"The program benefit details resource is used to view, create, update, and delete the program benefits added to a partner program.",
    "items":{
        "$ref":"#/components/schemas/partnerPrograms-ProgramBenefitDetails-item-post-request"
    }
}

Nested Schema : Tiers

Type: array

Title: Tiers

The partner program tiers resource is used to view, create, update, and delete the tiers for a given program. Partner programs can be arranged into tiers and assigned to partners based on their level of contribution to the business.

Show Source

• Array of: object partnerPrograms-ProgramTiers-item-post-request

{
    "title":"Tiers",
    "type":"array",
    "description":"The partner program tiers resource is used to view, create, update, and delete the tiers for a given program. Partner programs can be arranged into tiers and assigned to partners based on their level of contribution to the business.",
    "items":{
        "$ref":"#/components/schemas/partnerPrograms-ProgramTiers-item-post-request"
    }
}

Nested Schema : partnerPrograms-Attachments-item-post-request

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

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

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

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

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The 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"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : partnerPrograms-PartnerProgramCountries-item-post-request

Type: object

Show Source

• CountryCode: string
  Maximum Length: 2

  The country code to which the partner program applies.
• PartnerProgramId: integer
  The unique identifier for the partner program associated with the country.
• ProgramCountryId: integer
  The system-generated unique identifier and primary key for the program country.

{
    "type":"object",
    "properties":{
        "ProgramCountryId":{
            "type":"integer",
            "description":"The system-generated unique identifier and primary key for the program country.",
            "nullable":false,
            "x-queryable":false
        },
        "CountryCode":{
            "maxLength":"2",
            "type":"string",
            "description":"The country code to which the partner program applies.",
            "nullable":false
        },
        "PartnerProgramId":{
            "type":"integer",
            "description":"The unique identifier for the partner program associated with the country.",
            "nullable":false
        }
    }
}

Nested Schema : partnerPrograms-ProgramBenefitDetails-item-post-request

Type: object

Show Source

• BenefitListValue: string
  The list value of the program tier benefit when the value type of program benefit is "List".
• BenefitValue: string
  Title: Benefit Value

  Maximum Length: 150

  The value of a program tier benefit in a format appropriate for the program benefit's value type.
• Name: string
  Title: Name

  Maximum Length: 155

  The name of the program tier benefit.
• PartnerProgramId: integer (int64)
  Title: Program

  The unique identifier for the partner program to which the program tier benefit has been added.
• ProgramBenefitDetailId: integer
  Title: Program Benefit Details

  The system-generated unique identifier and primary key of the program tier benefit.
• ProgramBenefitId: integer (int64)
  Title: Benefit

  The unique identifier for a program benefit added to a program or program tier.
• TierId: integer (int64)
  Title: Tier

  The unique identifier for a tier to which a program tier benefit applies.

{
    "type":"object",
    "properties":{
        "TierId":{
            "title":"Tier",
            "type":"integer",
            "description":"The unique identifier for a tier to which a program tier benefit applies.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.partnerMgmt.partnerProgram.management.partnerProgramService.view.TierVO",
                "precision":"18",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Name",
                "fnd:FND_AUDIT_FK_WHEREATTR":"TierId"
            }
        },
        "PartnerProgramId":{
            "title":"Program",
            "type":"integer",
            "description":"The unique identifier for the partner program to which the program tier benefit has been added.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.partnerMgmt.partnerProgram.management.partnerProgramService.view.PartnerProgramsVO",
                "precision":"18",
                "ExtnEventActionProperty":"HideInFieldUpdate",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"ProgramName",
                "fnd:FND_AUDIT_FK_WHEREATTR":"PartnerProgramId"
            }
        },
        "BenefitListValue":{
            "type":"string",
            "description":"The list value of the program tier benefit when the value type of program benefit is \"List\".",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ProgramBenefitId":{
            "title":"Benefit",
            "type":"integer",
            "description":"The unique identifier for a program benefit added to a program or program tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "fnd:FND_AUDIT_USER_KEY":"true",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.partnerMgmt.partnerProgram.management.partnerProgramService.view.ProgramBenefitsVO",
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Name",
                "fnd:FND_AUDIT_FK_WHEREATTR":"ProgramBenefitId"
            }
        },
        "ProgramBenefitDetailId":{
            "title":"Program Benefit Details",
            "type":"integer",
            "description":"The system-generated unique identifier and primary key of the program tier benefit.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ExtnEventActionProperty":"HideInFieldUpdate;",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "BenefitValue":{
            "title":"Benefit Value",
            "maxLength":"150",
            "type":"string",
            "description":"The value of a program tier benefit in a format appropriate for the program benefit's value type.",
            "nullable":true,
            "x-hints":{
                "ExtnEventActionProperty":"UpdateInFieldUpdate",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"155",
            "type":"string",
            "description":"The name of the program tier benefit.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        }
    }
}

Nested Schema : partnerPrograms-ProgramTiers-item-post-request

Type: object

Show Source

• PartnerProgramId: integer (int64)
  The unique identifier for the partner program associated with the program tier.
• ProgramTierId: integer (int64)
  The unique identifier for a program tier added to a program.
• TierId: integer (int64)
  The unique identifier of the Tier which is being added to the program.

{
    "type":"object",
    "properties":{
        "TierId":{
            "type":"integer",
            "description":"The unique identifier of the Tier which is being added to the program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "ProgramTierId":{
            "type":"integer",
            "description":"The unique identifier for a program tier added to a program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartnerProgramId":{
            "type":"integer",
            "description":"The unique identifier for the partner program associated with the program tier.",
            "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 : partnerPrograms-item-response

Type: object

Show Source

• Attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• CountryNames: string
  Title: Countries

  Read Only: true

  The list of countries that apply to the program.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the row was created.
• DeleteFlag: boolean
  Read Only: true

  Indicates whether the program can be deleted. If the value is Y, then the program can be deleted. The default value is N.
• EndDateActive: string (date)
  Title: End Date

  The date when the partner program ends.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who last updated the row.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the program.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OwnerPartyNumber: string
  Title: Owner Party Number

  Read Only: true

  Maximum Length: 30

  Public Unique Identifier of Owner Party on the Partner Programs.
• PartnerProgramCountries: array Countries
  Title: Countries

  The countries resource is used to view, create, update, and delete the countries associated with partner programs. The countries resource is used to determine the scope of availability of partner programs in specific countries.
• PartnerProgramId: integer
  Title: Program ID

  The system-generated unique identifier and primary key of the partner program.
• ProgramBenefitDetails: array Program Benefit Details
  Title: Program Benefit Details

  The program benefit details resource is used to view, create, update, and delete the program benefits added to a partner program.
• ProgramDescription: string
  Title: Description

  Maximum Length: 1000

  The text describing the program.
• ProgramManagerId: integer
  Title: Program Manager ID

  The unique identifier for the owner of the partner program.
• ProgramManagerName: string
  Title: Owner

  Maximum Length: 360

  The name of the owner/manager of the partner program.
• ProgramName: string
  Title: Name

  Maximum Length: 150

  The name of the partner program.
• ProgramNumber: string
  Title: Program Number

  Maximum Length: 30

  The alternate key identifier generated for each program.
• ProgramTiers: array Tiers
  Title: Tiers

  The partner program tiers resource is used to view, create, update, and delete the tiers for a given program. Partner programs can be arranged into tiers and assigned to partners based on their level of contribution to the business.
• ProgramType: string
  Title: Type

  Maximum Length: 30

  The type of partner program. For example, Reseller or Go-to-Market.
• ProgramTypeMeaning: string
  Title: Type

  Read Only: true

  Maximum Length: 80

  The type of the partner program. The accepted values are developer, distributor, go to market, technology partner, product focus area, and reseller. A list of accepted values is defined in the lookup ZPM_PARTNER_PROGRAM_TYPE.
• StartDateActive: string (date)
  Title: Start Date

  The date when the partner program starts.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: D

  The code indicating the status of the program. For example, Draft, Failed, Published, Rejected, Pending, Terminatedm or Unpublished. A list of valid values is defined in the lookup ZPM_PROGRAM_STATUS .
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the program can be updated. If the value is Y, then the program can be updated. The default value is N.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramTiers":{
            "title":"Tiers",
            "type":"array",
            "description":"The partner program tiers resource is used to view, create, update, and delete the tiers for a given program. Partner programs can be arranged into tiers and assigned to partners based on their level of contribution to the business.",
            "items":{
                "$ref":"#/components/schemas/partnerPrograms-ProgramTiers-item-response"
            }
        },
        "OwnerPartyNumber":{
            "title":"Owner Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"Public Unique Identifier of Owner Party on the Partner Programs.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramBenefitDetails":{
            "title":"Program Benefit Details",
            "type":"array",
            "description":"The program benefit details resource is used to view, create, update, and delete the program benefits added to a partner program.",
            "items":{
                "$ref":"#/components/schemas/partnerPrograms-ProgramBenefitDetails-item-response"
            }
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the status of the program. For example, Draft, Failed, Published, Rejected, Pending, Terminatedm or Unpublished. A list of valid values is defined in the lookup ZPM_PROGRAM_STATUS .",
            "nullable":false,
            "default":"D",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/partnerPrograms-Attachments-item-response"
            }
        },
        "ProgramManagerId":{
            "title":"Program Manager ID",
            "type":"integer",
            "description":"The unique identifier for the owner of the partner program.",
            "nullable":false,
            "x-queryable":false
        },
        "CountryNames":{
            "title":"Countries",
            "type":"string",
            "description":"The list of countries that apply to the program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the partner program starts.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the program can be updated. If the value is Y, then the program can be updated. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProgramDescription":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The text describing the program.",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerProgramCountries":{
            "title":"Countries",
            "type":"array",
            "description":"The countries resource is used to view, create, update, and delete the countries associated with partner programs. The countries resource is used to determine the scope of availability of partner programs in specific countries.",
            "items":{
                "$ref":"#/components/schemas/partnerPrograms-PartnerProgramCountries-item-response"
            }
        },
        "ProgramNumber":{
            "title":"Program Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier generated for each program.",
            "nullable":false,
            "x-queryable":true
        },
        "ProgramManagerName":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the owner/manager of the partner program.",
            "nullable":false,
            "x-hints":{
                "controlType":"input_text_lov"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProgramType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of partner program. For example, Reseller or Go-to-Market.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramTypeMeaning":{
            "title":"Type",
            "maxLength":"80",
            "type":"string",
            "description":"The type of the partner program. The accepted values are developer, distributor, go to market, technology partner, product focus area, and reseller. A list of accepted values is defined in the lookup ZPM_PARTNER_PROGRAM_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PartnerProgramId":{
            "title":"Program ID",
            "type":"integer",
            "description":"The system-generated unique identifier and primary key of the partner program.",
            "nullable":false,
            "x-queryable":true
        },
        "ProgramName":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the partner program.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the program can be deleted. If the value is Y, then the program can be deleted. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the partner program ends.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object partnerPrograms-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/partnerPrograms-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 : Countries

Type: array

Title: Countries

The countries resource is used to view, create, update, and delete the countries associated with partner programs. The countries resource is used to determine the scope of availability of partner programs in specific countries.

Show Source

• Array of: object partnerPrograms-PartnerProgramCountries-item-response

{
    "title":"Countries",
    "type":"array",
    "description":"The countries resource is used to view, create, update, and delete the countries associated with partner programs. The countries resource is used to determine the scope of availability of partner programs in specific countries.",
    "items":{
        "$ref":"#/components/schemas/partnerPrograms-PartnerProgramCountries-item-response"
    }
}

Nested Schema : Program Benefit Details

Type: array

Title: Program Benefit Details

The program benefit details resource is used to view, create, update, and delete the program benefits added to a partner program.

Show Source

• Array of: object partnerPrograms-ProgramBenefitDetails-item-response

{
    "title":"Program Benefit Details",
    "type":"array",
    "description":"The program benefit details resource is used to view, create, update, and delete the program benefits added to a partner program.",
    "items":{
        "$ref":"#/components/schemas/partnerPrograms-ProgramBenefitDetails-item-response"
    }
}

Nested Schema : Tiers

Type: array

Title: Tiers

The partner program tiers resource is used to view, create, update, and delete the tiers for a given program. Partner programs can be arranged into tiers and assigned to partners based on their level of contribution to the business.

Show Source

• Array of: object partnerPrograms-ProgramTiers-item-response

{
    "title":"Tiers",
    "type":"array",
    "description":"The partner program tiers resource is used to view, create, update, and delete the tiers for a given program. Partner programs can be arranged into tiers and assigned to partners based on their level of contribution to the business.",
    "items":{
        "$ref":"#/components/schemas/partnerPrograms-ProgramTiers-item-response"
    }
}

Nested Schema : partnerPrograms-Attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

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

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

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

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

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

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The 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
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "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"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record 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
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : partnerPrograms-PartnerProgramCountries-item-response

Type: object

Show Source

• CountryCode: string
  Maximum Length: 2

  The country code to which the partner program applies.
• CountryName: string
  Title: Territory Name

  Read Only: true

  Maximum Length: 80

  The name of a country to which a partner program applies.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  The date and time the row was created.
• DeleteFlag: boolean
  Read Only: true

  Indicates whether the program countries can be deleted. If the value is Y, then the program countries can be deleted. The default value is N.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time the row was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartnerProgramId: integer
  The unique identifier for the partner program associated with the country.
• ProgramCountryId: integer
  The system-generated unique identifier and primary key for the program country.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CountryName":{
            "title":"Territory Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of a country to which a partner program applies.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerProgramId":{
            "type":"integer",
            "description":"The unique identifier for the partner program associated with the country.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProgramCountryId":{
            "type":"integer",
            "description":"The system-generated unique identifier and primary key for the program country.",
            "nullable":false,
            "x-queryable":false
        },
        "CountryCode":{
            "maxLength":"2",
            "type":"string",
            "description":"The country code to which the partner program applies.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the program countries can be deleted. If the value is Y, then the program countries can be deleted. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : partnerPrograms-ProgramBenefitDetails-item-response

Type: object

Show Source

• BenefitListValue: string
  The list value of the program tier benefit when the value type of program benefit is "List".
• BenefitValue: string
  Title: Benefit Value

  Maximum Length: 150

  The value of a program tier benefit in a format appropriate for the program benefit's value type.
• CategoryCode: string
  Title: Category

  Read Only: true

  Maximum Length: 30

  The code indicating the category of the program benefit. A list of valid values is defined in the lookup ORA_ZPM_BENEFIT_CATEGORY.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time the row was created.
• DataType: string
  Title: Value Type

  Read Only: true

  Maximum Length: 30

  The value type of the program benefit.
• DeleteFlag: boolean
  Read Only: true

  Indicates whether the program benefit can be deleted. If the value is Y, then the program benefit can be deleted. The default value is N.
• Description: string
  Title: Benefits Description

  Read Only: true

  Maximum Length: 1000

  The text describing the program benefit.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the row.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the program benefit detail.
• links: array Links
  Title: Links

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

  Maximum Length: 155

  The name of the program tier benefit.
• PartnerProgramId: integer (int64)
  Title: Program

  The unique identifier for the partner program to which the program tier benefit has been added.
• ProgramBenefitDetailId: integer
  Title: Program Benefit Details

  The system-generated unique identifier and primary key of the program tier benefit.
• ProgramBenefitId: integer (int64)
  Title: Benefit

  The unique identifier for a program benefit added to a program or program tier.
• TierId: integer (int64)
  Title: Tier

  The unique identifier for a tier to which a program tier benefit applies.
• TierName: string
  Title: Name

  Read Only: true

  Maximum Length: 155

  The name of a tier to which a program tier benefit applies.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the program benefit can be updated. If the value is Y, then the program benefit can be updated. The default value is N.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CategoryCode":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the category of the program benefit. A list of valid values is defined in the lookup ORA_ZPM_BENEFIT_CATEGORY.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Benefits Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The text describing the program benefit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PartnerProgramId":{
            "title":"Program",
            "type":"integer",
            "description":"The unique identifier for the partner program to which the program tier benefit has been added.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.partnerMgmt.partnerProgram.management.partnerProgramService.view.PartnerProgramsVO",
                "precision":"18",
                "ExtnEventActionProperty":"HideInFieldUpdate",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"ProgramName",
                "fnd:FND_AUDIT_FK_WHEREATTR":"PartnerProgramId"
            },
            "x-queryable":true
        },
        "BenefitListValue":{
            "type":"string",
            "description":"The list value of the program tier benefit when the value type of program benefit is \"List\".",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "ProgramBenefitId":{
            "title":"Benefit",
            "type":"integer",
            "description":"The unique identifier for a program benefit added to a program or program tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "fnd:FND_AUDIT_USER_KEY":"true",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.partnerMgmt.partnerProgram.management.partnerProgramService.view.ProgramBenefitsVO",
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Name",
                "fnd:FND_AUDIT_FK_WHEREATTR":"ProgramBenefitId"
            },
            "x-queryable":true
        },
        "BenefitValue":{
            "title":"Benefit Value",
            "maxLength":"150",
            "type":"string",
            "description":"The value of a program tier benefit in a format appropriate for the program benefit's value type.",
            "nullable":true,
            "x-hints":{
                "ExtnEventActionProperty":"UpdateInFieldUpdate",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the program benefit can be deleted. If the value is Y, then the program benefit can be deleted. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"155",
            "type":"string",
            "description":"The name of the program tier benefit.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the program benefit can be updated. If the value is Y, then the program benefit can be updated. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "TierId":{
            "title":"Tier",
            "type":"integer",
            "description":"The unique identifier for a tier to which a program tier benefit applies.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.partnerMgmt.partnerProgram.management.partnerProgramService.view.TierVO",
                "precision":"18",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Name",
                "fnd:FND_AUDIT_FK_WHEREATTR":"TierId"
            },
            "x-queryable":true
        },
        "TierName":{
            "title":"Name",
            "maxLength":"155",
            "type":"string",
            "description":"The name of a tier to which a program tier benefit applies.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "DataType":{
            "title":"Value Type",
            "maxLength":"30",
            "type":"string",
            "description":"The value type of the program benefit.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "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"
            }
        },
        "ProgramBenefitDetailId":{
            "title":"Program Benefit Details",
            "type":"integer",
            "description":"The system-generated unique identifier and primary key of the program tier benefit.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ExtnEventActionProperty":"HideInFieldUpdate;",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the program benefit detail.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInFieldUpdate;HideInEmailTemplate",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        }
    }
}

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 : partnerPrograms-ProgramTiers-item-response

Type: object

Show Source

• BadgeImageName: string
  Title: Badge

  Read Only: true

  Maximum Length: 100

  The badge image name of the program tier.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  The date and time the row was created.
• DeleteFlag: boolean
  Read Only: true

  Indicates whether the program tier should be deleted. If the value is Y, then the program tier has to be deleted. The default value is N.
• EnrollmentCount: integer
  Title: Enrollments

  Read Only: true

  The count of enrollments referencing the program tier.
• LastUpdateDate: string (date-time)
  Read Only: true

  The user who last updated the row.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The date and time the row was last updated.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 155

  The name of the program tier.
• PartnerProgramId: integer (int64)
  The unique identifier for the partner program associated with the program tier.
• ProgramTierId: integer (int64)
  The unique identifier for a program tier added to a program.
• Ranking: integer (int32)
  Title: Rank

  Read Only: true

  The rank of the program tier.
• TierId: integer (int64)
  The unique identifier of the Tier which is being added to the program.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The date and time the row was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ProgramTierId":{
            "type":"integer",
            "description":"The unique identifier for a program tier added to a program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartnerProgramId":{
            "type":"integer",
            "description":"The unique identifier for the partner program associated with the program tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BadgeImageName":{
            "title":"Badge",
            "maxLength":"100",
            "type":"string",
            "description":"The badge image name of the program tier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the program tier should be deleted. If the value is Y, then the program tier has to be deleted. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":"155",
            "type":"string",
            "description":"The name of the program tier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnrollmentCount":{
            "title":"Enrollments",
            "type":"integer",
            "description":"The count of enrollments referencing the program tier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Ranking":{
            "title":"Rank",
            "type":"integer",
            "description":"The rank of the program tier.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "TierId":{
            "type":"integer",
            "description":"The unique identifier of the Tier which is being added to the program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The user who last updated the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

Attachments

Operation: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/Attachments

Parameters:

• ProgramNumber: $request.path.ProgramNumber

The attachments resource is used to view, create, and update attachments.

PartnerProgramCountries

Operation: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/PartnerProgramCountries

Parameters:

• ProgramNumber: $request.path.ProgramNumber

The countries resource is used to view, create, update, and delete the countries associated with partner programs. The countries resource is used to determine the scope of availability of partner programs in specific countries.

ProgramBenefitDetails

Operation: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramBenefitDetails

Parameters:

• ProgramNumber: $request.path.ProgramNumber

The program benefit details resource is used to view, create, update, and delete the program benefits added to a partner program.

ProgramStatuses

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZPM_PROGRAM_STATUS%2CBindLookupCode%3D{StatusCode}

The list of values indicating the program status.

The following properties are defined on the LOV link relation:

• Source Attribute: StatusCode; Target Attribute: LookupCode
• Display Attribute: Meaning

ProgramTiers

Operation: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramTiers

Parameters:

• ProgramNumber: $request.path.ProgramNumber

The partner program tiers resource is used to view, create, update, and delete the tiers for a given program. Partner programs can be arranged into tiers and assigned to partners based on their level of contribution to the business.

ProgramTypes

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZPM_PARTNER_PROGRAM_TYPE%2CBindLookupCode%3D{ProgramType}

The list of values indicating the type of the partner program, such as Developer, Distributor, or Reseller.

The following properties are defined on the LOV link relation:

• Source Attribute: ProgramType; Target Attribute: LookupCode
• Display Attribute: Meaning

Resources

Operation: /crmRestApi/resources/11.13.18.05/resources

The list of values indicating the name of the owner or manager of the partner program, such as Colby Morris.

The following properties are defined on the LOV link relation:

• Source Attribute: ProgramManagerName; Target Attribute: ResourceName
• Display Attribute: ResourceFirstName, ResourceLastName, EmailAddress, OrganizationName, RoleName

delete

Operation: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/action/delete

Parameters:

• ProgramNumber: $request.path.ProgramNumber

This method lets you delete a partner program.

Back to Top

Examples

The following example shows how to create a partner program by submitting a post request on the REST resource using cURL.

cURL Command

curl -v -u Username:Password -H "content-type:application/vnd.oracle.adf.resourceitem+json" -X POST "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partnerPrograms" -d '{request_payload}'

Example of Request Body

The following shows an example of the request body in JSON format.

{ 
 "ProgramName": "North America program", 
 "ProgramManagerId": 100010038017885, 
 "ProgramType": "GTMI"
}

Example of Response Body

The following shows an example of the response body in JSON format.

{
  "PartnerProgramId" : 300100071293754,
  "ProgramName" : "North America program",
  "ProgramNumber" : "CDRM_12005",
  "ProgramDescription" : null,
  "StartDateActive" : null,
  "EndDateActive" : null,
  "ProgramManagerId" : 100010038017885,
  "ProgramManagerName" : "Channel_OPS_Mgr_ENT1 COM",
  "ProgramType" : "GTMI",
  "StatusCode" : "D",
  "CreatedBy" : "CHANNEL_OPERATIONS_MANAGER",
  "CreationDate" : "2016-02-17T12:57:37-08:00",
  "LastUpdateDate" : "2016-02-17T12:57:37-08:00",
  "LastUpdatedBy" : "CHANNEL_OPERATIONS_MANAGER",
  "DeleteFlag" : "true",
  "UpdateFlag" : "true",
  "CountryNames" : "",
...
}

Back to Top