Jump to

• Request
• Response
• Examples

Get a partner program for the enrollment

get

/crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/PartnerProgram/{PartnerProgramId}

Request

Path Parameters

• EnrollmentNumber(required): string
  The alternate key identifier of the program enrollment.
• PartnerProgramId(required): number
  The unique Identifier of the partner program associated with the enrollment. This is the primary key of the partnerprogram table.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : programEnrollments-PartnerProgram-item-response

Type: object

Show Source

• CountryNames: string
  Title: Countries

  Read Only: true

  The name of the countries for the program.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Indicates if the record can be deleted. The default value is false.
• EndDateActive: string (date)
  Title: End Date

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who updated the program record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• 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.
• PartnerProgramId: integer
  Title: Program ID

  The unique Identifier of the partner program associated with the enrollment. This is the primary key of the partnerprogram table.
• ProgramDescription: string
  Title: Description

  Maximum Length: 1000

  The description of the program.
• ProgramManagerId: integer
  Title: Program Manager ID

  The unique identifier of the person managing the partner program.
• ProgramManagerName: string
  Title: Owner

  Maximum Length: 360

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

  Maximum Length: 150

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

  Maximum Length: 30

  The unique number generated for the program.
• ProgramType: string
  Title: Type

  Maximum Length: 30

  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.
• 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 effective date when the program starts.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: D

  The status of the partner program. The accepted values are draft, pending, published, and terminated.
• UpdateFlag: boolean
  Read Only: true

  Indicates if the record can be updated. The default value is false.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who updated the program record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the program record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the program record.",
            "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
        },
        "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
        },
        "PartnerProgramId":{
            "title":"Program ID",
            "type":"integer",
            "description":"The unique Identifier of the partner program associated with the enrollment. This is the primary key of the partnerprogram table.",
            "nullable":false,
            "x-queryable":true
        },
        "ProgramName":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the partner program.",
            "nullable":false,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the partner program. The accepted values are draft, pending, published, and terminated.",
            "nullable":false,
            "default":"D",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the record can be deleted. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProgramManagerId":{
            "title":"Program Manager ID",
            "type":"integer",
            "description":"The unique identifier of the person managing the partner program.",
            "nullable":false,
            "x-queryable":false
        },
        "CountryNames":{
            "title":"Countries",
            "type":"string",
            "description":"The name of the countries for the program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The effective date when the program starts.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the record can be updated. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The effective data when the program ends.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "ProgramDescription":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the program.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramNumber":{
            "title":"Program Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique number generated for the program.",
            "nullable":false,
            "x-queryable":true
        },
        "ProgramManagerName":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the program manager.",
            "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 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,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the program record 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 record.",
            "nullable":true,
            "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"
    }
}

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

Links

ProgramStatuses

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

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

The list of values of program status

The following properties are defined on the LOV link relation:

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

ProgramTypes

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

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

The type of the selected partner program, such as Developer, Distributor, or Reseller, as defined in the program definition.

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 value of the selected partner program's owner, 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/programEnrollments/{EnrollmentNumber}/child/PartnerProgram/{PartnerProgramId}/action/delete

Parameters:

• EnrollmentNumber: $request.path.EnrollmentNumber
• PartnerProgramId: $request.path.PartnerProgramId

This method lets you delete a partner program.

Back to Top

Examples

The following example shows how to get a partner program for the enrollment by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/programEnrollments/ENRM_12345/child/PartnerProgram/300100000339515

Example of Response Body

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

{
PartnerProgramId: 300100000339515
ProgramName: "PLATINUM PROGRAM"
ProgramDescription: "PLATINUM PROGRAM"
StartDateActive: "2011-06-23"
EndDateActive: "2021-12-31"
PrimaryContactId: 100010038017891
ProgramManagerId: 100010032636167
ProgramManagerName: "John Doe"
ProgramType: "GTMI"
CreatedBy: "CHANNEL_PARTNER_MANAGER"
CreationDate: "2011-06-23T06:09:36-07:00"
LastUpdateDate: "2011-06-24T12:11:29-07:00"
LastUpdatedBy: "CHANNEL_OPERATIONS_MGR"
ProgramApproverId: 100010025532588
ProgramApproverUser: "BEN_ADMIN_S2"
EnrollmentApproverUser: "SALES_MGR"
-links:[7]
-0: {
      ...
    }
-1: {
      ...
    }
-2: {
      ...
    }
 ...
}

Back to Top