Jump to

• Request
• Response

Create a competitor account

post

/crmRestApi/resources/11.13.18.05/competitorAccounts

Request

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

• AnnualRevenueAmount: number
  Title: Annual Revenue Amount

  Indicates the competitor company's annual revenue.
• Attachment: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• CeoName: string
  Title: Chief Executive Name

  Maximum Length: 240

  The name of the organization's chief executive officer.
• Country: string
  Title: Country

  Maximum Length: 2

  The home country of the competitor.
• CreatedByModule: string
  Maximum Length: 30

  Default Value: SALES

  The module that created the competitor record.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code for annual revenue amount.
• DbRating: string
  Title: D&B Credit Rating

  Maximum Length: 5

  The Dun & Bradstreet credit rating.
• DUNSNumber: string
  Title: D-U-N-S Number

  Maximum Length: 30

  The DUNS Number in free form text format. The value is not restricted to nine digit number.
• FiscalYearendMonth: string
  Title: Fiscal Year End Month

  Maximum Length: 30

  The last month of a fiscal year for the organization. The list of accepted values is defined in the lookup type MONTH.
• IncorpYear: integer (int32)
  Title: Year Incorporated

  The year that the organization started business operations.
• LineOfBusiness: string
  Title: Line of Business

  Maximum Length: 240

  The type of business activities performed at this site.
• MinorityOwnedInd: string
  Title: Minority-Owned Indicator

  Maximum Length: 30

  Indicates whether the organization is primarily owned by ethnic or racial minorities. If the value is Y, then the organization is owned by ethnic or racial minorities. The company is primarily owned by ethnic or racial minorities. The default value is N.
• OrganizationName(required): string
  Title: Organization Name

  Maximum Length: 360

  The name of the competitor organization.
• OrganizationSize: string
  Title: Organization Size

  Maximum Length: 30

  The size of the competitor organization based on criteria such as revenue or number of employees.
• PartyId: integer (int64)
  The primary key for a competitor record.
• PartyName(required): string
  Title: Name

  Maximum Length: 360

  The name of the competitor organization.
• PartyNumber(required): string
  Title: Registry ID

  Maximum Length: 30

  The unique public identifier for a competitor.
• PartyType: string
  Title: Party Type

  Maximum Length: 30

  Default Value: ORGANIZATION

  The type of the party record.
• PublicPrivateOwnershipFlag: boolean
  Title: Private Ownership

  Maximum Length: 1

  Indicates whether the organization is publically or privately owned. If the value is Y, then the organization is a privately owned organization. The default value is N.
• SICCode: string
  Title: SIC Code

  Maximum Length: 30

  The Standard Industry Classification (SIC) code of the competitor.
• SmallBusInd: string
  Title: Small Business Indicator

  Maximum Length: 30

  Indicates whether the organization is considered as a small business. If the value is Y, then the organization is considered as a small business. The default value is N.
• StatusCode: string
  Title: Status

  Maximum Length: 10

  Default Value: ACTIVE

  The competitor status - ACTIVE OR INACTIVE.
• StockSymbol: string
  Title: Stock Symbol

  Maximum Length: 20

  The corporate stock symbol of the organization as listed in stock exchanges.
• ThreatLevelCode: string
  Title: Threat Level

  Maximum Length: 30

  The level of threat the competitor presents when competing against the deploying organization for a deal.
• TradingPartnerIdentifier: string
  Maximum Length: 30

  The FSIO related trading partner codes.
• UniqueNameSuffix: string
  Title: Name Suffix

  Maximum Length: 540

  The suffix used to generate the attribute PartyUniqueName. The suffix is linked to the OrganizationName attribute to generate the PartyUniqueName.
• URL: string
  Title: Primary URL

  Maximum Length: 2000

  The uniform resource locator or a website containing information about the competitor.
• YearEstablished: integer (int32)
  Title: Year Established

  The year that the organization started it business operations.

{
    "required":[
        "OrganizationName",
        "PartyName",
        "PartyNumber"
    ],
    "type":"object",
    "properties":{
        "OrganizationName":{
            "title":"Organization Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the competitor organization.",
            "nullable":false
        },
        "CeoName":{
            "title":"Chief Executive Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the organization's chief executive officer.",
            "nullable":true
        },
        "FiscalYearendMonth":{
            "title":"Fiscal Year End Month",
            "maxLength":"30",
            "type":"string",
            "description":"The last month of a fiscal year for the organization. The list of accepted values is defined in the lookup type MONTH.",
            "nullable":true
        },
        "DUNSNumber":{
            "title":"D-U-N-S Number",
            "maxLength":"30",
            "type":"string",
            "description":"The DUNS Number in free form text format. The value is not restricted to nine digit number.",
            "nullable":true
        },
        "StockSymbol":{
            "title":"Stock Symbol",
            "maxLength":"20",
            "type":"string",
            "description":"The corporate stock symbol of the organization as listed in stock exchanges.",
            "nullable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the competitor organization.",
            "nullable":false
        },
        "PublicPrivateOwnershipFlag":{
            "title":"Private Ownership",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the organization is publically or privately owned. If the value is Y, then the organization is a privately owned organization. The default value is N.",
            "nullable":true
        },
        "Attachment":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/competitorAccounts-Attachment-item-post-request"
            }
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"10",
            "type":"string",
            "description":"The competitor status - ACTIVE OR INACTIVE.",
            "nullable":true,
            "default":"ACTIVE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "URL":{
            "title":"Primary URL",
            "maxLength":"2000",
            "type":"string",
            "description":"The uniform resource locator or a website containing information about the competitor.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"WebEO.Url",
                "protectionObjectTitle":"URL",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"URL"
            }
        },
        "YearEstablished":{
            "title":"Year Established",
            "type":"integer",
            "description":"The year that the organization started it business operations.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"4"
            }
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code for annual revenue amount.",
            "nullable":true
        },
        "IncorpYear":{
            "title":"Year Incorporated",
            "type":"integer",
            "description":"The year that the organization started business operations.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"4"
            }
        },
        "AnnualRevenueAmount":{
            "title":"Annual Revenue Amount",
            "type":"number",
            "description":"Indicates the competitor company's annual revenue.",
            "nullable":true
        },
        "CreatedByModule":{
            "maxLength":"30",
            "type":"string",
            "description":"The module that created the competitor record.",
            "nullable":true,
            "default":"SALES"
        },
        "PartyType":{
            "title":"Party Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the party record.",
            "nullable":false,
            "default":"ORGANIZATION"
        },
        "ThreatLevelCode":{
            "title":"Threat Level",
            "maxLength":"30",
            "type":"string",
            "description":"The level of threat the competitor presents when competing against the deploying organization for a deal.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TradingPartnerIdentifier":{
            "maxLength":"30",
            "type":"string",
            "description":"The FSIO related trading partner codes.",
            "nullable":true
        },
        "MinorityOwnedInd":{
            "title":"Minority-Owned Indicator",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the organization is primarily owned by ethnic or racial minorities. If the value is Y, then the organization is owned by ethnic or racial minorities. The company is primarily owned by ethnic or racial minorities. The default value is N.",
            "nullable":true
        },
        "PartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique public identifier for a competitor.",
            "nullable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The primary key for a competitor record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrganizationSize":{
            "title":"Organization Size",
            "maxLength":"30",
            "type":"string",
            "description":"The size of the competitor organization based on criteria such as revenue or number of employees.",
            "nullable":true
        },
        "DbRating":{
            "title":"D&B Credit Rating",
            "maxLength":"5",
            "type":"string",
            "description":"The Dun & Bradstreet credit rating.",
            "nullable":true
        },
        "UniqueNameSuffix":{
            "title":"Name Suffix",
            "maxLength":"540",
            "type":"string",
            "description":"The suffix used to generate the attribute PartyUniqueName. The suffix is linked to the OrganizationName attribute to generate the PartyUniqueName.",
            "nullable":true
        },
        "LineOfBusiness":{
            "title":"Line of Business",
            "maxLength":"240",
            "type":"string",
            "description":"The type of business activities performed at this site.",
            "nullable":true
        },
        "SmallBusInd":{
            "title":"Small Business Indicator",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the organization is considered as a small business. If the value is Y, then the organization is considered as a small business. The default value is N.",
            "nullable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The home country of the competitor.",
            "nullable":true
        },
        "SICCode":{
            "title":"SIC Code",
            "maxLength":"30",
            "type":"string",
            "description":"The Standard Industry Classification (SIC) code of the competitor.",
            "nullable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object schema

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/competitorAccounts-Attachment-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : competitorAccounts-item-response

Type: object

Show Source

• AnnualRevenueAmount: number
  Title: Annual Revenue Amount

  Indicates the competitor company's annual revenue.
• Attachment: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• CeoName: string
  Title: Chief Executive Name

  Maximum Length: 240

  The name of the organization's chief executive officer.
• Country: string
  Title: Country

  Maximum Length: 2

  The home country of the competitor.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the competitor record.
• CreatedByModule: string
  Maximum Length: 30

  Default Value: SALES

  The module that created the competitor record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code for annual revenue amount.
• DbRating: string
  Title: D&B Credit Rating

  Maximum Length: 5

  The Dun & Bradstreet credit rating.
• DeletetFlag: boolean
  Read Only: true

  Indicates whether the competitor can be deleted.
• DUNSNumber: string
  Title: D-U-N-S Number

  Maximum Length: 30

  The DUNS Number in free form text format. The value is not restricted to nine digit number.
• FiscalYearendMonth: string
  Title: Fiscal Year End Month

  Maximum Length: 30

  The last month of a fiscal year for the organization. The list of accepted values is defined in the lookup type MONTH.
• IncorpYear: integer (int32)
  Title: Year Incorporated

  The year that the organization started business operations.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who last updated the competitor record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• LineOfBusiness: string
  Title: Line of Business

  Maximum Length: 240

  The type of business activities performed at this site.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MinorityOwnedInd: string
  Title: Minority-Owned Indicator

  Maximum Length: 30

  Indicates whether the organization is primarily owned by ethnic or racial minorities. If the value is Y, then the organization is owned by ethnic or racial minorities. The company is primarily owned by ethnic or racial minorities. The default value is N.
• OrganizationName: string
  Title: Organization Name

  Maximum Length: 360

  The name of the competitor organization.
• OrganizationSize: string
  Title: Organization Size

  Maximum Length: 30

  The size of the competitor organization based on criteria such as revenue or number of employees.
• PartyId: integer (int64)
  The primary key for a competitor record.
• PartyName: string
  Title: Name

  Maximum Length: 360

  The name of the competitor organization.
• PartyNumber: string
  Title: Registry ID

  Maximum Length: 30

  The unique public identifier for a competitor.
• PartyType: string
  Title: Party Type

  Maximum Length: 30

  Default Value: ORGANIZATION

  The type of the party record.
• PublicPrivateOwnershipFlag: boolean
  Title: Private Ownership

  Maximum Length: 1

  Indicates whether the organization is publically or privately owned. If the value is Y, then the organization is a privately owned organization. The default value is N.
• SICCode: string
  Title: SIC Code

  Maximum Length: 30

  The Standard Industry Classification (SIC) code of the competitor.
• SmallBusInd: string
  Title: Small Business Indicator

  Maximum Length: 30

  Indicates whether the organization is considered as a small business. If the value is Y, then the organization is considered as a small business. The default value is N.
• StatusCode: string
  Title: Status

  Maximum Length: 10

  Default Value: ACTIVE

  The competitor status - ACTIVE OR INACTIVE.
• StockSymbol: string
  Title: Stock Symbol

  Maximum Length: 20

  The corporate stock symbol of the organization as listed in stock exchanges.
• ThreatLevelCode: string
  Title: Threat Level

  Maximum Length: 30

  The level of threat the competitor presents when competing against the deploying organization for a deal.
• TradingPartnerIdentifier: string
  Maximum Length: 30

  The FSIO related trading partner codes.
• UniqueNameSuffix: string
  Title: Name Suffix

  Maximum Length: 540

  The suffix used to generate the attribute PartyUniqueName. The suffix is linked to the OrganizationName attribute to generate the PartyUniqueName.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the record can be updated.
• URL: string
  Title: Primary URL

  Maximum Length: 2000

  The uniform resource locator or a website containing information about the competitor.
• YearEstablished: integer (int32)
  Title: Year Established

  The year that the organization started it business operations.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "title":"Organization Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the competitor organization.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CeoName":{
            "title":"Chief Executive Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the organization's chief executive officer.",
            "nullable":true,
            "x-queryable":true
        },
        "FiscalYearendMonth":{
            "title":"Fiscal Year End Month",
            "maxLength":"30",
            "type":"string",
            "description":"The last month of a fiscal year for the organization. The list of accepted values is defined in the lookup type MONTH.",
            "nullable":true,
            "x-queryable":true
        },
        "DUNSNumber":{
            "title":"D-U-N-S Number",
            "maxLength":"30",
            "type":"string",
            "description":"The DUNS Number in free form text format. The value is not restricted to nine digit number.",
            "nullable":true,
            "x-queryable":true
        },
        "StockSymbol":{
            "title":"Stock Symbol",
            "maxLength":"20",
            "type":"string",
            "description":"The corporate stock symbol of the organization as listed in stock exchanges.",
            "nullable":true,
            "x-queryable":true
        },
        "DeletetFlag":{
            "type":"boolean",
            "description":"Indicates whether the competitor can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the competitor organization.",
            "nullable":false,
            "x-queryable":true
        },
        "PublicPrivateOwnershipFlag":{
            "title":"Private Ownership",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the organization is publically or privately owned. If the value is Y, then the organization is a privately owned organization. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "Attachment":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/competitorAccounts-Attachment-item-response"
            }
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"10",
            "type":"string",
            "description":"The competitor status - ACTIVE OR INACTIVE.",
            "nullable":true,
            "default":"ACTIVE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "URL":{
            "title":"Primary URL",
            "maxLength":"2000",
            "type":"string",
            "description":"The uniform resource locator or a website containing information about the competitor.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"WebEO.Url",
                "protectionObjectTitle":"URL",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"URL"
            },
            "x-queryable":true
        },
        "YearEstablished":{
            "title":"Year Established",
            "type":"integer",
            "description":"The year that the organization started it business operations.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code for annual revenue amount.",
            "nullable":true,
            "x-queryable":true
        },
        "IncorpYear":{
            "title":"Year Incorporated",
            "type":"integer",
            "description":"The year that the organization started business operations.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the record can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AnnualRevenueAmount":{
            "title":"Annual Revenue Amount",
            "type":"number",
            "description":"Indicates the competitor company's annual revenue.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreatedByModule":{
            "maxLength":"30",
            "type":"string",
            "description":"The module that created the competitor record.",
            "nullable":true,
            "default":"SALES",
            "x-queryable":true
        },
        "PartyType":{
            "title":"Party Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the party record.",
            "nullable":false,
            "default":"ORGANIZATION",
            "x-queryable":true
        },
        "ThreatLevelCode":{
            "title":"Threat Level",
            "maxLength":"30",
            "type":"string",
            "description":"The level of threat the competitor presents when competing against the deploying organization for a deal.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the competitor record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TradingPartnerIdentifier":{
            "maxLength":"30",
            "type":"string",
            "description":"The FSIO related trading partner codes.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the competitor record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MinorityOwnedInd":{
            "title":"Minority-Owned Indicator",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the organization is primarily owned by ethnic or racial minorities. If the value is Y, then the organization is owned by ethnic or racial minorities. The company is primarily owned by ethnic or racial minorities. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique public identifier for a competitor.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The primary key for a competitor record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationSize":{
            "title":"Organization Size",
            "maxLength":"30",
            "type":"string",
            "description":"The size of the competitor organization based on criteria such as revenue or number of employees.",
            "nullable":true,
            "x-queryable":true
        },
        "DbRating":{
            "title":"D&B Credit Rating",
            "maxLength":"5",
            "type":"string",
            "description":"The Dun & Bradstreet credit rating.",
            "nullable":true,
            "x-queryable":true
        },
        "UniqueNameSuffix":{
            "title":"Name Suffix",
            "maxLength":"540",
            "type":"string",
            "description":"The suffix used to generate the attribute PartyUniqueName. The suffix is linked to the OrganizationName attribute to generate the PartyUniqueName.",
            "nullable":true,
            "x-queryable":true
        },
        "LineOfBusiness":{
            "title":"Line of Business",
            "maxLength":"240",
            "type":"string",
            "description":"The type of business activities performed at this site.",
            "nullable":true,
            "x-queryable":true
        },
        "SmallBusInd":{
            "title":"Small Business Indicator",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the organization is considered as a small business. If the value is Y, then the organization is considered as a small business. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The home country of the competitor.",
            "nullable":true,
            "x-queryable":true
        },
        "SICCode":{
            "title":"SIC Code",
            "maxLength":"30",
            "type":"string",
            "description":"The Standard Industry Classification (SIC) code of the competitor.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object competitorAccounts-Attachment-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/competitorAccounts-Attachment-item-response"
    }
}

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 : competitorAccounts-Attachment-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

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

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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

Attachment

Operation: /crmRestApi/resources/11.13.18.05/competitorAccounts/{PartyId}/child/Attachment

Parameters:

• PartyId: $request.path.PartyId

The attachments resource is used to view, create, and update attachments.

CompttrStatusLookupForSearch

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZBS_SALES_COMPTTR_STATUS

The following properties are defined on the LOV link relation:

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

CompttrThrtLvlLookupLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeFinder%3BBindLookupType%3DZBS_SALES_COMPTTR_THRT_LVL

The following properties are defined on the LOV link relation:

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

Back to Top