Jump to

• Request
• Response
• Examples

Get all competitor accounts

get

/crmRestApi/resources/11.13.18.05/competitorAccounts

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • ActiveCompetitorsFinder: Finds an active competitor.
    Finder Variables:
    • PartyNumber; string; The unique public identifier for a competitor.
    • PartyUniqueName; string; The unique name for a competitor.
    • ThreatLevelCode; string; The level of threat for a competitor.
  • PartyIdAltKey: Finds a competitor with the specified party identifier.
    Finder Variables:
    • PartyId; integer; The primary key for a competitor record.
  • PartyNumberAltKeyFinder: Finds a competitor with the specified public identifier.
    Finder Variables:
    • PartyNumber; string; The unique public identifier for a competitor.
  • PrimaryKey: Finds a competitor with the specified primary key.
    Finder Variables:
    • PartyId; integer; The primary key for a competitor record.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AnnualRevenueAmount; number; Indicates the competitor company's annual revenue.
  • CeoName; string; The name of the organization's chief executive officer.
  • Country; string; The home country of the competitor.
  • CreatedBy; string; The user who created the competitor record.
  • CreatedByModule; string; The module that created the competitor record.
  • CreationDate; string; The date when the record was created.
  • CurrencyCode; string; The currency code for annual revenue amount.
  • DUNSNumber; string; The DUNS Number in free form text format. The value is not restricted to nine digit number.
  • DbRating; string; The Dun & Bradstreet credit rating.
  • DeletetFlag; boolean; Indicates whether the competitor can be deleted.
  • FiscalYearendMonth; string; The last month of a fiscal year for the organization. The list of accepted values is defined in the lookup type MONTH.
  • IncorpYear; integer; The year that the organization started business operations.
  • LastUpdateDate; string; The date when the record was last updated.
  • LastUpdateLogin; string; The login of the user who last updated the record.
  • LastUpdatedBy; string; The user who last updated the competitor record.
  • LineOfBusiness; string; The type of business activities performed at this site.
  • MinorityOwnedInd; string; 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; The name of the competitor organization.
  • OrganizationSize; string; The size of the competitor organization based on criteria such as revenue or number of employees.
  • PartyId; integer; The primary key for a competitor record.
  • PartyName; string; The name of the competitor organization.
  • PartyNumber; string; The unique public identifier for a competitor.
  • PartyType; string; The type of the party record.
  • PublicPrivateOwnershipFlag; boolean; 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; The Standard Industry Classification (SIC) code of the competitor.
  • SmallBusInd; string; 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; The competitor status - ACTIVE OR INACTIVE.
  • StockSymbol; string; The corporate stock symbol of the organization as listed in stock exchanges.
  • ThreatLevelCode; string; The level of threat the competitor presents when competing against the deploying organization for a deal.
  • TradingPartnerIdentifier; string; The FSIO related trading partner codes.
  • URL; string; The uniform resource locator or a website containing information about the competitor.
  • UniqueNameSuffix; string; The suffix used to generate the attribute PartyUniqueName. The suffix is linked to the OrganizationName attribute to generate the PartyUniqueName.
  • UpdateFlag; boolean; Indicates whether the record can be updated.
  • YearEstablished; integer; The year that the organization started it business operations.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/competitorAccounts-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object competitorAccounts-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/competitorAccounts-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-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."
        }
    }
}

Back to Top

Examples

The following example shows how to get all competitor accounts by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/competitorAccounts

Example of Response Body

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

{
    "items": [
         {
            "PartyId": 300100017959625,
            "PartyNumber": "CDRM_9146",
            "PartyName": "ACmpttr172013181841413611PUK",
            "PartyType": "ORGANIZATION",
            "OrganizationName": "ACmpttr172013181841413611PUK",
            "UniqueNameSuffix": null,
            "OrganizationSize": null,
            "SICCode": null,
            "TradingPartnerIdentifier": null,
            "CeoName": null,
            "DbRating": null,
            "DUNSNumber": null,
            "FiscalYearendMonth": null,
            "IncorpYear": null,
            "LineOfBusiness": null,
            "MinorityOwnedInd": null,
            "SmallBusInd": null,
            "StockSymbol": null,
            "YearEstablished": null,
            "PublicPrivateOwnershipFlag": null,
            "AnnualRevenueAmount": null,
            "CurrencyCode": null,
            "StatusCode": "INACTIVE",
            "ThreatLevelCode": "HIGH",
            "URL": null,
            "Country": null,
            "CreatedByModule": "SALES",
            "CreatedBy": "SALES_ADMIN",
            "CreationDate": "2013-01-07T18:22:34+00:00",
            "UpdateFlag": "false",
            "DeletetFlag": "false",
            "LastUpdateDate": "2015-03-18T22:31:25+00:00",
            "LastUpdateLogin": "119E7E511D369D5AE0531833F40A581A",
            "LastUpdatedBy": "SALES_ADMIN",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/competitorAccounts/300100017959625",
                    "name": "competitorAccounts",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000003770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000017371007E0002000000017371007E00020000000278"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/competitorAccounts/300100017959625",
                    "name": "competitorAccounts",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/competitorAccounts/300100017959625/child/Attachment",
                    "name": "Attachment",
                    "kind": "collection"
                }
            ]
        },
  .....
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/competitorAccounts",
            "name": "competitorAccounts",
            "kind": "collection"
        }
    ]
}

Back to Top