Jump to

• Request
• Response
• Examples

Create a country for a partner program

post

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

Request

Path Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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":{
        "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
        },
        "ProgramCountryId":{
            "type":"integer",
            "description":"The system-generated unique identifier and primary key for the program country.",
            "nullable":false,
            "x-queryable":false
        }
    }
}

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-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":{
        "CountryCode":{
            "maxLength":2,
            "type":"string",
            "description":"The country code to which the partner program applies.",
            "nullable":false,
            "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
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created 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
        },
        "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
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "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
        },
        "ProgramCountryId":{
            "type":"integer",
            "description":"The system-generated unique identifier and primary key for the program country.",
            "nullable":false,
            "x-queryable":false
        },
        "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."
        }
    }
}

Back to Top

Examples

The following example shows how to create a country for 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/CDRM_12005/child/PartnerProgramCountries" -d '{request_payload}'

Example of Request Body

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

{ 
    "CountryCode": "ES"
}

Example of Response Body

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

{
  "CountryCode" : "ES",
  "CreatedBy" : "CHANNEL_OPERATIONS_MANAGER",
  "CreationDate" : "2016-02-17T17:12:40-08:00",
  "LastUpdateDate" : "2016-02-17T17:12:40-08:00",
  "LastUpdatedBy" : "CHANNEL_OPERATIONS_MANAGER",
  "PartnerProgramId" : 300100071293754,
  "ProgramCountryId" : 300100071293763,
  "CountryName" : "Spain",
  "DeleteFlag" : "true",
...
}  

Back to Top