Jump to

• Request
• Response
• Examples

Update a tier for a partner program

patch

/crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramTiers/{ProgramTierId}

Request

Path Parameters

• ProgramNumber(required): string
  The alternate key identifier generated for each program.
• ProgramTierId(required): integer(int64)
  The unique identifier for a program tier added to a program.

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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-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":{
        "BadgeImageName":{
            "title":"Badge",
            "maxLength":100,
            "type":"string",
            "description":"The badge image name of the program tier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "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
        },
        "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
        },
        "EnrollmentCount":{
            "title":"Enrollments",
            "type":"integer",
            "description":"The count of enrollments referencing the program tier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The user who last updated the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The date and time the row was last updated.",
            "nullable":false,
            "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
        },
        "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
        },
        "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
        },
        "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"
            }
        }
    }
}

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

Tiers

Operation: /crmRestApi/resources/11.13.18.05/partnerTiers

The list of values indicating the tiers.

The following properties are defined on the LOV link relation:

• Source Attribute: TierId; Target Attribute: TierId
• Display Attribute: Name

Back to Top

Examples

The following example shows how to update a tier for a patner program by submitting a patch request on the REST resource using cURL.

cURL Command

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

Example of Request Body

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

{ "TierId": 300100071293754}

Example of Response Body

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

{
  "ProgramTierId" : 300100071293760,
  "PartnerProgramId" : 300100071293754,
  "TierId" : 300100071293754,
  "CreatedBy" : "CHANNEL_OPERATIONS_MANAGER",
  "CreationDate" : "2016-02-17T14:58:33-08:00",
  "LastUpdatedBy" : "CHANNEL_OPERATIONS_MANAGER",
  "LastUpdateDate" : "2016-02-17T14:58:33-08:00",
  "Name" : "Gold Tier",
  "BadgeImageName" : null,
  "Ranking" : 1,
  "EnrollmentCount" : 0,
  "DeleteFlag" : "true",
...
}

Back to Top