Jump to

• Request
• Response

Create an industry for a partner

post

/crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/industries

Request

Path Parameters

• CompanyNumber(required): string
  The alternate key identifier of the partner's company.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ClassificationCategory: string
  Maximum Length: 30

  The classification category of the industry being served.
• ClassificationCode: string
  Title: Partner Type

  Maximum Length: 30

  The code indicating the type of the industry being served.
• ClassificationName: string
  Maximum Length: 360

  The display name of the classification of the industry being served.
• PartnerDimMembersId: integer (int64)
  Title: Industry ID

  The unique identifier of the industry with the partner.

{
    "type":"object",
    "properties":{
        "ClassificationName":{
            "maxLength":"360",
            "type":"string",
            "description":"The display name of the classification of the industry being served.",
            "nullable":false
        },
        "ClassificationCategory":{
            "maxLength":"30",
            "type":"string",
            "description":"The classification category of the industry being served.",
            "nullable":true
        },
        "PartnerDimMembersId":{
            "title":"Industry ID",
            "type":"integer",
            "description":"The unique identifier of the industry with the partner.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ClassificationCode":{
            "title":"Partner Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the industry being served.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : partners-industries-item-response

Type: object

Show Source

• ClassificationCategory: string
  Maximum Length: 30

  The classification category of the industry being served.
• ClassificationCode: string
  Title: Partner Type

  Maximum Length: 30

  The code indicating the type of the industry being served.
• ClassificationName: string
  Maximum Length: 360

  The display name of the classification of the industry being served.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the record was created.
• DimensionMemberName: string
  Title: Name

  Read Only: true

  Maximum Length: 60

  The classification name of the industry served.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the 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.
• PartnerDimMembersId: integer (int64)
  Title: Industry ID

  The unique identifier of the industry with the partner.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DimensionMemberName":{
            "title":"Name",
            "maxLength":"60",
            "type":"string",
            "description":"The classification name of the industry served.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationCode":{
            "title":"Partner Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the industry being served.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ClassificationName":{
            "maxLength":"360",
            "type":"string",
            "description":"The display name of the classification of the industry being served.",
            "nullable":false,
            "x-queryable":true
        },
        "ClassificationCategory":{
            "maxLength":"30",
            "type":"string",
            "description":"The classification category of the industry being served.",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerDimMembersId":{
            "title":"Industry ID",
            "type":"integer",
            "description":"The unique identifier of the industry with the partner.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the 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":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."
        }
    }
}

Links

AllIndustriesLookup

Back to Top