Jump to

• Request
• Response

Create a competitor

post

/crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Competitors

Request

Path Parameters

• Name(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context:
  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

• Id: string
  Maximum Length: 80

  The unique identifier of a competitor.
• LineOfBusiness: string
  Maximum Length: 240

  The line of business of the competitor.
• Name: string
  Maximum Length: 360

  The name of the competitor.
• NameSuffix: string
  Maximum Length: 540

  The name suffix of the competitor.
• OrganizationSize: string
  Maximum Length: 80

  The size of the organization based on its revenue, number of employees, and others.
• ThreatLevel: string
  Maximum Length: 80

  The level of threat to signify the competitive risk.

{
    "type":"object",
    "properties":{
        "OrganizationSize":{
            "maxLength":80,
            "type":"string",
            "description":"The size of the organization based on its revenue, number of employees, and others.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ThreatLevel":{
            "maxLength":80,
            "type":"string",
            "description":"The level of threat to signify the competitive risk.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LineOfBusiness":{
            "maxLength":240,
            "type":"string",
            "description":"The line of business of the competitor.",
            "nullable":true
        },
        "NameSuffix":{
            "maxLength":540,
            "type":"string",
            "description":"The name suffix of the competitor.",
            "nullable":true
        },
        "Id":{
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of a competitor.",
            "nullable":false
        },
        "Name":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the competitor.",
            "nullable":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 : setupAssistants-Competitors-item-response

Type: object

Show Source

• Id: string
  Maximum Length: 80

  The unique identifier of a competitor.
• LineOfBusiness: string
  Maximum Length: 240

  The line of business of the competitor.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Maximum Length: 360

  The name of the competitor.
• NameSuffix: string
  Maximum Length: 540

  The name suffix of the competitor.
• OrganizationSize: string
  Maximum Length: 80

  The size of the organization based on its revenue, number of employees, and others.
• ThreatLevel: string
  Maximum Length: 80

  The level of threat to signify the competitive risk.

{
    "type":"object",
    "properties":{
        "OrganizationSize":{
            "maxLength":80,
            "type":"string",
            "description":"The size of the organization based on its revenue, number of employees, and others.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ThreatLevel":{
            "maxLength":80,
            "type":"string",
            "description":"The level of threat to signify the competitive risk.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LineOfBusiness":{
            "maxLength":240,
            "type":"string",
            "description":"The line of business of the competitor.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NameSuffix":{
            "maxLength":540,
            "type":"string",
            "description":"The name suffix of the competitor.",
            "nullable":true,
            "x-queryable":true
        },
        "Id":{
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of a competitor.",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the competitor.",
            "nullable":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 : 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