mirror of https://github.com/vernonkeenan/lib
Refactor Swagger definitions to use external references for Address, CompanyProduct, CompanyService, Factor, FinancialStatement, Industry, IndustryCompany, IndustryProduct, IndustryService, Observation, and Topic. This improves modularity and maintainability of the API specification.
parent
7b878f86d5
commit
2e3fdeec39
|
@ -20,7 +20,7 @@ import (
|
||||||
|
|
||||||
// CompanyProduct A software product or service vended by a Company
|
// CompanyProduct A software product or service vended by a Company
|
||||||
//
|
//
|
||||||
// swagger:model CompanyProduct
|
// swagger:model companyProduct
|
||||||
type CompanyProduct struct {
|
type CompanyProduct struct {
|
||||||
|
|
||||||
// Account Email
|
// Account Email
|
||||||
|
|
|
@ -20,7 +20,7 @@ import (
|
||||||
|
|
||||||
// CompanyService A service performed by a Company
|
// CompanyService A service performed by a Company
|
||||||
//
|
//
|
||||||
// swagger:model CompanyService
|
// swagger:model companyService
|
||||||
type CompanyService struct {
|
type CompanyService struct {
|
||||||
|
|
||||||
// Account Email
|
// Account Email
|
||||||
|
|
|
@ -20,7 +20,7 @@ import (
|
||||||
|
|
||||||
// Factor A Factor of analysis within a research topic
|
// Factor A Factor of analysis within a research topic
|
||||||
//
|
//
|
||||||
// swagger:model Factor
|
// swagger:model factor
|
||||||
type Factor struct {
|
type Factor struct {
|
||||||
|
|
||||||
// Created By User ID
|
// Created By User ID
|
||||||
|
|
|
@ -18,7 +18,7 @@ import (
|
||||||
|
|
||||||
// FinancialStatement A financial statement for a company
|
// FinancialStatement A financial statement for a company
|
||||||
//
|
//
|
||||||
// swagger:model FinancialStatement
|
// swagger:model financialStatement
|
||||||
type FinancialStatement struct {
|
type FinancialStatement struct {
|
||||||
|
|
||||||
// EDGAR Access Number
|
// EDGAR Access Number
|
||||||
|
|
|
@ -20,7 +20,7 @@ import (
|
||||||
|
|
||||||
// Industry An industry that is being researched
|
// Industry An industry that is being researched
|
||||||
//
|
//
|
||||||
// swagger:model Industry
|
// swagger:model industry
|
||||||
type Industry struct {
|
type Industry struct {
|
||||||
|
|
||||||
// The list of Products in this industry
|
// The list of Products in this industry
|
||||||
|
|
|
@ -16,14 +16,23 @@ import (
|
||||||
"github.com/go-openapi/swag"
|
"github.com/go-openapi/swag"
|
||||||
)
|
)
|
||||||
|
|
||||||
// IndustryCompany Junction object between Industry and Company
|
// IndustryCompany Junction object between Industry and Company (Account)
|
||||||
//
|
//
|
||||||
// swagger:model IndustryCompany
|
// swagger:model industryCompany
|
||||||
type IndustryCompany struct {
|
type IndustryCompany struct {
|
||||||
|
|
||||||
// company ID
|
// company ID
|
||||||
CompanyID *string `json:"CompanyID,omitempty"`
|
CompanyID *string `json:"CompanyID,omitempty"`
|
||||||
|
|
||||||
|
// company name
|
||||||
|
CompanyName *string `json:"CompanyName,omitempty"`
|
||||||
|
|
||||||
|
// company slug
|
||||||
|
CompanySlug *string `json:"CompanySlug,omitempty"`
|
||||||
|
|
||||||
|
// company tag line
|
||||||
|
CompanyTagLine *string `json:"CompanyTagLine,omitempty"`
|
||||||
|
|
||||||
// Created By User ID
|
// Created By User ID
|
||||||
CreatedByID *string `json:"CreatedByID,omitempty"`
|
CreatedByID *string `json:"CreatedByID,omitempty"`
|
||||||
|
|
||||||
|
@ -36,6 +45,15 @@ type IndustryCompany struct {
|
||||||
// industry ID
|
// industry ID
|
||||||
IndustryID *string `json:"IndustryID,omitempty"`
|
IndustryID *string `json:"IndustryID,omitempty"`
|
||||||
|
|
||||||
|
// industry name
|
||||||
|
IndustryName *string `json:"IndustryName,omitempty"`
|
||||||
|
|
||||||
|
// industry slug
|
||||||
|
IndustrySlug *string `json:"IndustrySlug,omitempty"`
|
||||||
|
|
||||||
|
// industry tag line
|
||||||
|
IndustryTagLine *string `json:"IndustryTagLine,omitempty"`
|
||||||
|
|
||||||
// Last Modified By User ID
|
// Last Modified By User ID
|
||||||
LastModifiedByID *string `json:"LastModifiedByID,omitempty"`
|
LastModifiedByID *string `json:"LastModifiedByID,omitempty"`
|
||||||
|
|
||||||
|
|
|
@ -18,7 +18,7 @@ import (
|
||||||
|
|
||||||
// IndustryProduct Junction object between Industry and CompanyProduct
|
// IndustryProduct Junction object between Industry and CompanyProduct
|
||||||
//
|
//
|
||||||
// swagger:model IndustryProduct
|
// swagger:model industryProduct
|
||||||
type IndustryProduct struct {
|
type IndustryProduct struct {
|
||||||
|
|
||||||
// company product ID
|
// company product ID
|
||||||
|
|
|
@ -19,7 +19,7 @@ import (
|
||||||
|
|
||||||
// IndustryService Junction Object bewtwen Industry and CompanyService
|
// IndustryService Junction Object bewtwen Industry and CompanyService
|
||||||
//
|
//
|
||||||
// swagger:model IndustryService
|
// swagger:model industryService
|
||||||
type IndustryService struct {
|
type IndustryService struct {
|
||||||
|
|
||||||
// company service
|
// company service
|
||||||
|
|
|
@ -18,7 +18,7 @@ import (
|
||||||
|
|
||||||
// Observation A data point collected while analyzing a Factor
|
// Observation A data point collected while analyzing a Factor
|
||||||
//
|
//
|
||||||
// swagger:model Observation
|
// swagger:model observation
|
||||||
type Observation struct {
|
type Observation struct {
|
||||||
|
|
||||||
// The ID of the Company being analyzed
|
// The ID of the Company being analyzed
|
||||||
|
|
|
@ -20,7 +20,7 @@ import (
|
||||||
|
|
||||||
// Topic A research topic that collects data
|
// Topic A research topic that collects data
|
||||||
//
|
//
|
||||||
// swagger:model Topic
|
// swagger:model topic
|
||||||
type Topic struct {
|
type Topic struct {
|
||||||
|
|
||||||
// Created By User ID
|
// Created By User ID
|
||||||
|
|
|
@ -235,8 +235,29 @@ func (m *Industry) UnmarshalBinary(b []byte) error {
|
||||||
// swagger:model IndustryCompanyProductsItems0
|
// swagger:model IndustryCompanyProductsItems0
|
||||||
type IndustryCompanyProductsItems0 struct {
|
type IndustryCompanyProductsItems0 struct {
|
||||||
|
|
||||||
|
// Account Email
|
||||||
|
AccountEmail *string `json:"AccountEmail,omitempty"`
|
||||||
|
|
||||||
// ID of the Company that owns this Product
|
// ID of the Company that owns this Product
|
||||||
AccountID string `json:"AccountID,omitempty"`
|
AccountID *string `json:"AccountID,omitempty"`
|
||||||
|
|
||||||
|
// Account Logo
|
||||||
|
AccountLogo *string `json:"AccountLogo,omitempty"`
|
||||||
|
|
||||||
|
// Account Name
|
||||||
|
AccountName *string `json:"AccountName,omitempty"`
|
||||||
|
|
||||||
|
// Account Number
|
||||||
|
AccountNumber *string `json:"AccountNumber,omitempty"`
|
||||||
|
|
||||||
|
// Account Publish
|
||||||
|
AccountPublish *bool `json:"AccountPublish,omitempty"`
|
||||||
|
|
||||||
|
// Account Slug
|
||||||
|
AccountSlug *string `json:"AccountSlug,omitempty"`
|
||||||
|
|
||||||
|
// Account Website
|
||||||
|
AccountWebsite *string `json:"AccountWebsite,omitempty"`
|
||||||
|
|
||||||
// Salesforce AppExchange URL
|
// Salesforce AppExchange URL
|
||||||
AppExchange *string `json:"AppExchange,omitempty"`
|
AppExchange *string `json:"AppExchange,omitempty"`
|
||||||
|
@ -271,7 +292,7 @@ type IndustryCompanyProductsItems0 struct {
|
||||||
// Last Enriched By User ID
|
// Last Enriched By User ID
|
||||||
LastEnrichedByID *string `json:"LastEnrichedByID,omitempty"`
|
LastEnrichedByID *string `json:"LastEnrichedByID,omitempty"`
|
||||||
|
|
||||||
// Last Enrichment Date
|
// Last Enriched Date
|
||||||
LastEnrichmentDate *string `json:"LastEnrichmentDate,omitempty"`
|
LastEnrichmentDate *string `json:"LastEnrichmentDate,omitempty"`
|
||||||
|
|
||||||
// Last Modified By User ID
|
// Last Modified By User ID
|
||||||
|
@ -402,9 +423,30 @@ func (m *IndustryCompanyProductsItems0) UnmarshalBinary(b []byte) error {
|
||||||
// swagger:model IndustryCompanyServicesItems0
|
// swagger:model IndustryCompanyServicesItems0
|
||||||
type IndustryCompanyServicesItems0 struct {
|
type IndustryCompanyServicesItems0 struct {
|
||||||
|
|
||||||
|
// Account Email
|
||||||
|
AccountEmail *string `json:"AccountEmail,omitempty"`
|
||||||
|
|
||||||
// ID of the Company that owns this Service
|
// ID of the Company that owns this Service
|
||||||
AccountID string `json:"AccountID,omitempty"`
|
AccountID string `json:"AccountID,omitempty"`
|
||||||
|
|
||||||
|
// Account Logo
|
||||||
|
AccountLogo *string `json:"AccountLogo,omitempty"`
|
||||||
|
|
||||||
|
// Account Name
|
||||||
|
AccountName *string `json:"AccountName,omitempty"`
|
||||||
|
|
||||||
|
// Account Number
|
||||||
|
AccountNumber *string `json:"AccountNumber,omitempty"`
|
||||||
|
|
||||||
|
// Account Publish
|
||||||
|
AccountPublish *bool `json:"AccountPublish,omitempty"`
|
||||||
|
|
||||||
|
// Account Slug
|
||||||
|
AccountSlug *string `json:"AccountSlug,omitempty"`
|
||||||
|
|
||||||
|
// Account Website
|
||||||
|
AccountWebsite *string `json:"AccountWebsite,omitempty"`
|
||||||
|
|
||||||
// Salesforce AppExchange URL
|
// Salesforce AppExchange URL
|
||||||
AppExchange *string `json:"AppExchange,omitempty"`
|
AppExchange *string `json:"AppExchange,omitempty"`
|
||||||
|
|
||||||
|
@ -432,10 +474,13 @@ type IndustryCompanyServicesItems0 struct {
|
||||||
// Image URL
|
// Image URL
|
||||||
ImageURL *string `json:"ImageURL,omitempty"`
|
ImageURL *string `json:"ImageURL,omitempty"`
|
||||||
|
|
||||||
|
// Industries
|
||||||
|
Industries []*Industry `json:"Industries"`
|
||||||
|
|
||||||
// Last Enriched By User ID
|
// Last Enriched By User ID
|
||||||
LastEnrichedByID *string `json:"LastEnrichedByID,omitempty"`
|
LastEnrichedByID *string `json:"LastEnrichedByID,omitempty"`
|
||||||
|
|
||||||
// Last Enrichment Date
|
// Last Enriched Date
|
||||||
LastEnrichmentDate *string `json:"LastEnrichmentDate,omitempty"`
|
LastEnrichmentDate *string `json:"LastEnrichmentDate,omitempty"`
|
||||||
|
|
||||||
// Last Modified By User ID
|
// Last Modified By User ID
|
||||||
|
@ -471,11 +516,75 @@ type IndustryCompanyServicesItems0 struct {
|
||||||
|
|
||||||
// Validate validates this industry company services items0
|
// Validate validates this industry company services items0
|
||||||
func (m *IndustryCompanyServicesItems0) Validate(formats strfmt.Registry) error {
|
func (m *IndustryCompanyServicesItems0) Validate(formats strfmt.Registry) error {
|
||||||
|
var res []error
|
||||||
|
|
||||||
|
if err := m.validateIndustries(formats); err != nil {
|
||||||
|
res = append(res, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(res) > 0 {
|
||||||
|
return errors.CompositeValidationError(res...)
|
||||||
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// ContextValidate validates this industry company services items0 based on context it is used
|
func (m *IndustryCompanyServicesItems0) validateIndustries(formats strfmt.Registry) error {
|
||||||
|
if swag.IsZero(m.Industries) { // not required
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
for i := 0; i < len(m.Industries); i++ {
|
||||||
|
if swag.IsZero(m.Industries[i]) { // not required
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if m.Industries[i] != nil {
|
||||||
|
if err := m.Industries[i].Validate(formats); err != nil {
|
||||||
|
if ve, ok := err.(*errors.Validation); ok {
|
||||||
|
return ve.ValidateName("Industries" + "." + strconv.Itoa(i))
|
||||||
|
} else if ce, ok := err.(*errors.CompositeError); ok {
|
||||||
|
return ce.ValidateName("Industries" + "." + strconv.Itoa(i))
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ContextValidate validate this industry company services items0 based on the context it is used
|
||||||
func (m *IndustryCompanyServicesItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error {
|
func (m *IndustryCompanyServicesItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error {
|
||||||
|
var res []error
|
||||||
|
|
||||||
|
if err := m.contextValidateIndustries(ctx, formats); err != nil {
|
||||||
|
res = append(res, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(res) > 0 {
|
||||||
|
return errors.CompositeValidationError(res...)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *IndustryCompanyServicesItems0) contextValidateIndustries(ctx context.Context, formats strfmt.Registry) error {
|
||||||
|
|
||||||
|
for i := 0; i < len(m.Industries); i++ {
|
||||||
|
|
||||||
|
if m.Industries[i] != nil {
|
||||||
|
if err := m.Industries[i].ContextValidate(ctx, formats); err != nil {
|
||||||
|
if ve, ok := err.(*errors.Validation); ok {
|
||||||
|
return ve.ValidateName("Industries" + "." + strconv.Itoa(i))
|
||||||
|
} else if ce, ok := err.(*errors.CompositeError); ok {
|
||||||
|
return ce.ValidateName("Industries" + "." + strconv.Itoa(i))
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -1,12 +1,38 @@
|
||||||
CompanyProduct:
|
CompanyProduct:
|
||||||
description: A software product or service vended by a Company
|
description: A software product or service vended by a Company
|
||||||
properties:
|
properties:
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
AccountID:
|
AccountID:
|
||||||
description: ID of the Company that owns this Product
|
description: ID of the Company that owns this Product
|
||||||
type: string
|
type: string
|
||||||
|
x-nullable: true
|
||||||
|
AccountNumber:
|
||||||
|
description: Account Number
|
||||||
|
type: string
|
||||||
|
x-nullable: true
|
||||||
|
AccountName:
|
||||||
|
description: Account Name
|
||||||
|
type: string
|
||||||
|
x-nullable: true
|
||||||
|
AccountPublish:
|
||||||
|
description: Account Publish
|
||||||
|
type: boolean
|
||||||
|
x-nullable: true
|
||||||
|
AccountWebsite:
|
||||||
|
description: Account Website
|
||||||
|
type: string
|
||||||
|
x-nullable: true
|
||||||
|
AccountEmail:
|
||||||
|
description: Account Email
|
||||||
|
type: string
|
||||||
|
x-nullable: true
|
||||||
|
AccountLogo:
|
||||||
|
description: Account Logo
|
||||||
|
type: string
|
||||||
|
x-nullable: true
|
||||||
|
AccountSlug:
|
||||||
|
description: Account Slug
|
||||||
|
type: string
|
||||||
|
x-nullable: true
|
||||||
AppExchange:
|
AppExchange:
|
||||||
description: Salesforce AppExchange URL
|
description: Salesforce AppExchange URL
|
||||||
type: string
|
type: string
|
||||||
|
@ -31,6 +57,9 @@ CompanyProduct:
|
||||||
description: Full Description of product
|
description: Full Description of product
|
||||||
type: string
|
type: string
|
||||||
x-nullable: true
|
x-nullable: true
|
||||||
|
ID:
|
||||||
|
description: Record Id
|
||||||
|
type: string
|
||||||
ImageAltText:
|
ImageAltText:
|
||||||
description: Image Alt Text
|
description: Image Alt Text
|
||||||
type: string
|
type: string
|
||||||
|
@ -39,12 +68,18 @@ CompanyProduct:
|
||||||
description: Image URL
|
description: Image URL
|
||||||
type: string
|
type: string
|
||||||
x-nullable: true
|
x-nullable: true
|
||||||
|
Industries:
|
||||||
|
description: Industries
|
||||||
|
items:
|
||||||
|
$ref: "./industry.yaml#/Industry"
|
||||||
|
type: array
|
||||||
|
x-nullable: true
|
||||||
LastEnrichedByID:
|
LastEnrichedByID:
|
||||||
description: Last Enriched By User ID
|
description: Last Enriched By User ID
|
||||||
type: string
|
type: string
|
||||||
x-nullable: true
|
x-nullable: true
|
||||||
LastEnrichmentDate:
|
LastEnrichmentDate:
|
||||||
description: Last Enrichment Date
|
description: Last Enriched Date
|
||||||
type: string
|
type: string
|
||||||
x-nullable: true
|
x-nullable: true
|
||||||
LastModifiedByID:
|
LastModifiedByID:
|
||||||
|
@ -87,10 +122,4 @@ CompanyProduct:
|
||||||
description: Website
|
description: Website
|
||||||
type: string
|
type: string
|
||||||
x-nullable: true
|
x-nullable: true
|
||||||
Industries:
|
|
||||||
description: Industries
|
|
||||||
items:
|
|
||||||
$ref: "./industry.yaml#/Industry"
|
|
||||||
type: array
|
|
||||||
x-nullable: true
|
|
||||||
type: object
|
type: object
|
||||||
|
|
|
@ -7,6 +7,34 @@ CompanyService:
|
||||||
AccountID:
|
AccountID:
|
||||||
description: ID of the Company that owns this Service
|
description: ID of the Company that owns this Service
|
||||||
type: string
|
type: string
|
||||||
|
AccountNumber:
|
||||||
|
description: Account Number
|
||||||
|
type: string
|
||||||
|
x-nullable: true
|
||||||
|
AccountName:
|
||||||
|
description: Account Name
|
||||||
|
type: string
|
||||||
|
x-nullable: true
|
||||||
|
AccountPublish:
|
||||||
|
description: Account Publish
|
||||||
|
type: boolean
|
||||||
|
x-nullable: true
|
||||||
|
AccountWebsite:
|
||||||
|
description: Account Website
|
||||||
|
type: string
|
||||||
|
x-nullable: true
|
||||||
|
AccountEmail:
|
||||||
|
description: Account Email
|
||||||
|
type: string
|
||||||
|
x-nullable: true
|
||||||
|
AccountLogo:
|
||||||
|
description: Account Logo
|
||||||
|
type: string
|
||||||
|
x-nullable: true
|
||||||
|
AccountSlug:
|
||||||
|
description: Account Slug
|
||||||
|
type: string
|
||||||
|
x-nullable: true
|
||||||
AppExchange:
|
AppExchange:
|
||||||
description: Salesforce AppExchange URL
|
description: Salesforce AppExchange URL
|
||||||
type: string
|
type: string
|
||||||
|
@ -39,12 +67,18 @@ CompanyService:
|
||||||
description: Image URL
|
description: Image URL
|
||||||
type: string
|
type: string
|
||||||
x-nullable: true
|
x-nullable: true
|
||||||
|
Industries:
|
||||||
|
description: Industries
|
||||||
|
items:
|
||||||
|
$ref: "./industry.yaml#/Industry"
|
||||||
|
type: array
|
||||||
|
x-nullable: true
|
||||||
LastEnrichedByID:
|
LastEnrichedByID:
|
||||||
description: Last Enriched By User ID
|
description: Last Enriched By User ID
|
||||||
type: string
|
type: string
|
||||||
x-nullable: true
|
x-nullable: true
|
||||||
LastEnrichmentDate:
|
LastEnrichmentDate:
|
||||||
description: Last Enrichment Date
|
description: Last Enriched Date
|
||||||
type: string
|
type: string
|
||||||
x-nullable: true
|
x-nullable: true
|
||||||
LastModifiedByID:
|
LastModifiedByID:
|
||||||
|
|
|
@ -1,9 +1,6 @@
|
||||||
Factor:
|
Factor:
|
||||||
description: A Factor of analysis within a research topic
|
description: A Factor of analysis within a research topic
|
||||||
properties:
|
properties:
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
CreatedByID:
|
CreatedByID:
|
||||||
description: Created By User ID
|
description: Created By User ID
|
||||||
type: string
|
type: string
|
||||||
|
@ -16,6 +13,9 @@ Factor:
|
||||||
description: Topic Description
|
description: Topic Description
|
||||||
type: string
|
type: string
|
||||||
x-nullable: true
|
x-nullable: true
|
||||||
|
ID:
|
||||||
|
description: Record Id
|
||||||
|
type: string
|
||||||
LastModifiedByID:
|
LastModifiedByID:
|
||||||
description: Last Modified By User ID
|
description: Last Modified By User ID
|
||||||
type: string
|
type: string
|
||||||
|
@ -23,6 +23,7 @@ Factor:
|
||||||
LastModifiedDate:
|
LastModifiedDate:
|
||||||
description: Last Modified Date
|
description: Last Modified Date
|
||||||
type: string
|
type: string
|
||||||
|
x-nullable: true
|
||||||
Name:
|
Name:
|
||||||
description: Factor Name
|
description: Factor Name
|
||||||
type: string
|
type: string
|
||||||
|
|
|
@ -1,52 +1,67 @@
|
||||||
FinancialStatement:
|
FinancialStatement:
|
||||||
type: object
|
|
||||||
description: A financial statement for a company
|
description: A financial statement for a company
|
||||||
properties:
|
properties:
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
AccessNumber:
|
AccessNumber:
|
||||||
description: EDGAR Access Number
|
description: EDGAR Access Number
|
||||||
type: string
|
type: string
|
||||||
|
x-nullable: true
|
||||||
AccountID:
|
AccountID:
|
||||||
description: Account ID
|
description: Account ID
|
||||||
type: string
|
type: string
|
||||||
|
x-nullable: true
|
||||||
CloudRevenue:
|
CloudRevenue:
|
||||||
description: Cloud Revenue
|
description: Cloud Revenue
|
||||||
type: number
|
type: number
|
||||||
|
x-nullable: true
|
||||||
CreatedByID:
|
CreatedByID:
|
||||||
description: Created By User ID
|
description: Created By User ID
|
||||||
type: string
|
type: string
|
||||||
|
x-nullable: true
|
||||||
CreatedDate:
|
CreatedDate:
|
||||||
description: Created Date
|
description: Created Date
|
||||||
type: string
|
type: string
|
||||||
|
x-nullable: true
|
||||||
Description:
|
Description:
|
||||||
description: Description
|
description: Description
|
||||||
type: string
|
type: string
|
||||||
|
x-nullable: true
|
||||||
EdgarURL:
|
EdgarURL:
|
||||||
description: EDGAR URL
|
description: EDGAR URL
|
||||||
type: string
|
type: string
|
||||||
|
x-nullable: true
|
||||||
FilingType:
|
FilingType:
|
||||||
description: Filing Type
|
description: Filing Type
|
||||||
type: string
|
type: string
|
||||||
|
x-nullable: true
|
||||||
GrossProfit:
|
GrossProfit:
|
||||||
description: Gross Profit
|
description: Gross Profit
|
||||||
type: number
|
type: number
|
||||||
|
x-nullable: true
|
||||||
|
ID:
|
||||||
|
description: Record Id
|
||||||
|
type: string
|
||||||
LastModifiedByID:
|
LastModifiedByID:
|
||||||
description: Last Modified By User ID
|
description: Last Modified By User ID
|
||||||
type: string
|
type: string
|
||||||
|
x-nullable: true
|
||||||
LastModifiedDate:
|
LastModifiedDate:
|
||||||
description: Last Modified Date
|
description: Last Modified Date
|
||||||
type: string
|
type: string
|
||||||
|
x-nullable: true
|
||||||
NetIncome:
|
NetIncome:
|
||||||
description: Net Income
|
description: Net Income
|
||||||
type: number
|
type: number
|
||||||
|
x-nullable: true
|
||||||
PeriodEndDate:
|
PeriodEndDate:
|
||||||
description: Period End Date
|
description: Period End Date
|
||||||
type: string
|
type: string
|
||||||
|
x-nullable: true
|
||||||
TotalRevenue:
|
TotalRevenue:
|
||||||
description: Total Revenue
|
description: Total Revenue
|
||||||
type: number
|
type: number
|
||||||
|
x-nullable: true
|
||||||
Year:
|
Year:
|
||||||
description: Year
|
description: Year
|
||||||
type: string
|
type: string
|
||||||
|
x-nullable: true
|
||||||
|
type: object
|
||||||
|
|
|
@ -1,25 +1,50 @@
|
||||||
IndustryCompany:
|
IndustryCompany:
|
||||||
description: Junction object between Industry and Company
|
description: Junction object between Industry and Company (Account)
|
||||||
properties:
|
properties:
|
||||||
ID:
|
CompanyID:
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
AccountID:
|
|
||||||
type: string
|
type: string
|
||||||
|
x-nullable: true
|
||||||
CreatedByID:
|
CreatedByID:
|
||||||
description: Created By User ID
|
description: Created By User ID
|
||||||
type: string
|
type: string
|
||||||
|
x-nullable: true
|
||||||
CreatedDate:
|
CreatedDate:
|
||||||
description: Created Date
|
description: Created Date
|
||||||
type: string
|
type: string
|
||||||
|
x-nullable: true
|
||||||
|
ID:
|
||||||
|
description: Record Id
|
||||||
|
type: string
|
||||||
IndustryID:
|
IndustryID:
|
||||||
type: string
|
type: string
|
||||||
|
x-nullable: true
|
||||||
LastModifiedByID:
|
LastModifiedByID:
|
||||||
description: Last Modified By User ID
|
description: Last Modified By User ID
|
||||||
type: string
|
type: string
|
||||||
|
x-nullable: true
|
||||||
LastModifiedDate:
|
LastModifiedDate:
|
||||||
description: Last Modified Date
|
description: Last Modified Date
|
||||||
type: string
|
type: string
|
||||||
|
x-nullable: true
|
||||||
Path:
|
Path:
|
||||||
type: string
|
type: string
|
||||||
|
x-nullable: true
|
||||||
|
CompanyName:
|
||||||
|
type: string
|
||||||
|
x-nullable: true
|
||||||
|
CompanySlug:
|
||||||
|
type: string
|
||||||
|
x-nullable: true
|
||||||
|
CompanyTagLine:
|
||||||
|
type: string
|
||||||
|
x-nullable: true
|
||||||
|
IndustryName:
|
||||||
|
type: string
|
||||||
|
x-nullable: true
|
||||||
|
IndustrySlug:
|
||||||
|
type: string
|
||||||
|
x-nullable: true
|
||||||
|
IndustryTagLine:
|
||||||
|
type: string
|
||||||
|
x-nullable: true
|
||||||
type: object
|
type: object
|
||||||
|
|
|
@ -1,11 +1,6 @@
|
||||||
IndustryProduct:
|
IndustryProduct:
|
||||||
description: Junction object between Industry and CompanyProduct
|
description: Junction object between Industry and CompanyProduct
|
||||||
properties:
|
properties:
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
CompanyProduct:
|
|
||||||
$ref: "./company-product.yaml#/CompanyProduct"
|
|
||||||
CompanyProductID:
|
CompanyProductID:
|
||||||
type: string
|
type: string
|
||||||
x-nullable: true
|
x-nullable: true
|
||||||
|
@ -17,8 +12,12 @@ IndustryProduct:
|
||||||
description: Created Date
|
description: Created Date
|
||||||
type: string
|
type: string
|
||||||
x-nullable: true
|
x-nullable: true
|
||||||
Industry:
|
HTML:
|
||||||
$ref: "./industry.yaml#/Industry"
|
type: string
|
||||||
|
x-nullable: true
|
||||||
|
ID:
|
||||||
|
description: Record Id
|
||||||
|
type: string
|
||||||
IndustryID:
|
IndustryID:
|
||||||
type: string
|
type: string
|
||||||
x-nullable: true
|
x-nullable: true
|
||||||
|
|
|
@ -1,9 +1,6 @@
|
||||||
Topic:
|
Topic:
|
||||||
description: A research topic that collects data
|
description: A research topic that collects data
|
||||||
properties:
|
properties:
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
CreatedByID:
|
CreatedByID:
|
||||||
description: Created By User ID
|
description: Created By User ID
|
||||||
type: string
|
type: string
|
||||||
|
@ -22,6 +19,9 @@ Topic:
|
||||||
$ref: "./factor.yaml#/Factor"
|
$ref: "./factor.yaml#/Factor"
|
||||||
type: array
|
type: array
|
||||||
x-nullable: true
|
x-nullable: true
|
||||||
|
ID:
|
||||||
|
description: Record Id
|
||||||
|
type: string
|
||||||
LastModifiedByID:
|
LastModifiedByID:
|
||||||
description: Last Modified By User ID
|
description: Last Modified By User ID
|
||||||
type: string
|
type: string
|
||||||
|
|
|
@ -1151,36 +1151,7 @@ paths:
|
||||||
|
|
||||||
definitions:
|
definitions:
|
||||||
Address:
|
Address:
|
||||||
properties:
|
$ref: "../../lib/swagger/defs/address.yaml#/Address"
|
||||||
City:
|
|
||||||
description: City
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Country:
|
|
||||||
description: Country full name
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CountryCode:
|
|
||||||
description: Country Code
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
PostalCode:
|
|
||||||
description: Postal Code
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
State:
|
|
||||||
description: State full name
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
StateCode:
|
|
||||||
description: State Code
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Street:
|
|
||||||
description: Street number and name
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
type: object
|
|
||||||
CompanyCategory:
|
CompanyCategory:
|
||||||
properties:
|
properties:
|
||||||
CloudType:
|
CloudType:
|
||||||
|
@ -1200,137 +1171,12 @@ definitions:
|
||||||
Meta:
|
Meta:
|
||||||
$ref: "#/definitions/ResponseMeta"
|
$ref: "#/definitions/ResponseMeta"
|
||||||
type: object
|
type: object
|
||||||
CompanyProduct:
|
|
||||||
description: A software product or service vended by a Company
|
|
||||||
properties:
|
|
||||||
AccountID:
|
|
||||||
description: ID of the Company that owns this Product
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AccountNumber:
|
|
||||||
description: Account Number
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AccountName:
|
|
||||||
description: Account Name
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AccountPublish:
|
|
||||||
description: Account Publish
|
|
||||||
type: boolean
|
|
||||||
x-nullable: true
|
|
||||||
AccountWebsite:
|
|
||||||
description: Account Website
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AccountEmail:
|
|
||||||
description: Account Email
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AccountLogo:
|
|
||||||
description: Account Logo
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AccountSlug:
|
|
||||||
description: Account Slug
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AppExchange:
|
|
||||||
description: Salesforce AppExchange URL
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedByID:
|
|
||||||
description: Created By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedDate:
|
|
||||||
description: Created Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Description:
|
|
||||||
description: Description of product
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
EnrichmentStatus:
|
|
||||||
description: Enrichment Status
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
FullDescription:
|
|
||||||
description: Full Description of product
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
ImageAltText:
|
|
||||||
description: Image Alt Text
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ImageURL:
|
|
||||||
description: Image URL
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Industries:
|
|
||||||
description: Industries
|
|
||||||
items:
|
|
||||||
$ref: "#/definitions/Industry"
|
|
||||||
type: array
|
|
||||||
x-nullable: true
|
|
||||||
LastEnrichedByID:
|
|
||||||
description: Last Enriched By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastEnrichmentDate:
|
|
||||||
description: Last Enriched Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedByID:
|
|
||||||
description: Last Modified By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedDate:
|
|
||||||
description: Last Modified Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Logo:
|
|
||||||
description: Logo
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Name:
|
|
||||||
description: Product Name
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ProductVideoID:
|
|
||||||
description: Product Video ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Published:
|
|
||||||
description: Published
|
|
||||||
type: boolean
|
|
||||||
x-nullable: true
|
|
||||||
SalesforceSpecific:
|
|
||||||
description: Salesforce Specific
|
|
||||||
type: boolean
|
|
||||||
x-nullable: true
|
|
||||||
Slug:
|
|
||||||
description: Slug
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
TagLine:
|
|
||||||
description: TagLine
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
URL:
|
|
||||||
description: Website
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
type: object
|
|
||||||
CompanyProductRequest:
|
CompanyProductRequest:
|
||||||
description: An array of CompanyProduct objects submitted for processing
|
description: An array of CompanyProduct objects submitted for processing
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/CompanyProduct"
|
$ref: "../../lib/swagger/defs/company-product.yaml#/CompanyProduct"
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
CompanyProductResponse:
|
CompanyProductResponse:
|
||||||
|
@ -1338,141 +1184,17 @@ definitions:
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/CompanyProduct"
|
$ref: "../../lib/swagger/defs/company-product.yaml#/CompanyProduct"
|
||||||
type: array
|
type: array
|
||||||
Meta:
|
Meta:
|
||||||
$ref: "#/definitions/ResponseMeta"
|
$ref: "#/definitions/ResponseMeta"
|
||||||
type: object
|
type: object
|
||||||
CompanyService:
|
|
||||||
description: A service performed by a Company
|
|
||||||
properties:
|
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
AccountID:
|
|
||||||
description: ID of the Company that owns this Service
|
|
||||||
type: string
|
|
||||||
AccountNumber:
|
|
||||||
description: Account Number
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AccountName:
|
|
||||||
description: Account Name
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AccountPublish:
|
|
||||||
description: Account Publish
|
|
||||||
type: boolean
|
|
||||||
x-nullable: true
|
|
||||||
AccountWebsite:
|
|
||||||
description: Account Website
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AccountEmail:
|
|
||||||
description: Account Email
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AccountLogo:
|
|
||||||
description: Account Logo
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AccountSlug:
|
|
||||||
description: Account Slug
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AppExchange:
|
|
||||||
description: Salesforce AppExchange URL
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedByID:
|
|
||||||
description: Created By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedDate:
|
|
||||||
description: Created Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Description:
|
|
||||||
description: Description of service
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
EnrichmentStatus:
|
|
||||||
description: Enrichment Status
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
FullDescription:
|
|
||||||
description: Full Description of service
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ImageAltText:
|
|
||||||
description: Image Alt Text
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ImageURL:
|
|
||||||
description: Image URL
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Industries:
|
|
||||||
description: Industries
|
|
||||||
items:
|
|
||||||
$ref: "#/definitions/Industry"
|
|
||||||
type: array
|
|
||||||
x-nullable: true
|
|
||||||
LastEnrichedByID:
|
|
||||||
description: Last Enriched By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastEnrichmentDate:
|
|
||||||
description: Last Enriched Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedByID:
|
|
||||||
description: Last Modified By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedDate:
|
|
||||||
description: Last Modified Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Logo:
|
|
||||||
description: Logo
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Name:
|
|
||||||
description: Service Name
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Published:
|
|
||||||
description: Published
|
|
||||||
type: boolean
|
|
||||||
x-nullable: true
|
|
||||||
SalesforceSpecific:
|
|
||||||
description: Salesforce Specific
|
|
||||||
type: boolean
|
|
||||||
x-nullable: true
|
|
||||||
ServiceVideoID:
|
|
||||||
description: Service Video ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Slug:
|
|
||||||
description: Slug
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
TagLine:
|
|
||||||
description: Tag Line
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
URL:
|
|
||||||
description: URL
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
type: object
|
|
||||||
CompanyServiceRequest:
|
CompanyServiceRequest:
|
||||||
description: An array of CompanyService objects submitted for processing
|
description: An array of CompanyService objects submitted for processing
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/CompanyService"
|
$ref: "../../lib/swagger/defs/company-service.yaml#/CompanyService"
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
CompanyServiceResponse:
|
CompanyServiceResponse:
|
||||||
|
@ -1480,7 +1202,7 @@ definitions:
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/CompanyService"
|
$ref: "../../lib/swagger/defs/company-service.yaml#/CompanyService"
|
||||||
type: array
|
type: array
|
||||||
Meta:
|
Meta:
|
||||||
$ref: "#/definitions/ResponseMeta"
|
$ref: "#/definitions/ResponseMeta"
|
||||||
|
@ -1496,57 +1218,12 @@ definitions:
|
||||||
type: object
|
type: object
|
||||||
Error:
|
Error:
|
||||||
$ref: ../../lib/swagger/defs/error.yaml#/Error
|
$ref: ../../lib/swagger/defs/error.yaml#/Error
|
||||||
Factor:
|
|
||||||
description: A Factor of analysis within a research topic
|
|
||||||
properties:
|
|
||||||
CreatedByID:
|
|
||||||
description: Created By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedDate:
|
|
||||||
description: Created Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Description:
|
|
||||||
description: Topic Description
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
LastModifiedByID:
|
|
||||||
description: Last Modified By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedDate:
|
|
||||||
description: Last Modified Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Name:
|
|
||||||
description: Factor Name
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Observations:
|
|
||||||
description: The list of Observations used to analyze this industry
|
|
||||||
items:
|
|
||||||
$ref: "#/definitions/Observation"
|
|
||||||
type: array
|
|
||||||
x-nullable: true
|
|
||||||
Slug:
|
|
||||||
description: The slug of the corresponding page on the CMS
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
TopicID:
|
|
||||||
description: The ID of the Topic that owns this Factor
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
type: object
|
|
||||||
FactorRequest:
|
FactorRequest:
|
||||||
description: An array of Factor objects submitted for processing
|
description: An array of Factor objects submitted for processing
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/Factor"
|
$ref: "../../lib/swagger/defs/factor.yaml#/Factor"
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
FactorResponse:
|
FactorResponse:
|
||||||
|
@ -1554,84 +1231,17 @@ definitions:
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/Factor"
|
$ref: "../../lib/swagger/defs/factor.yaml#/Factor"
|
||||||
type: array
|
type: array
|
||||||
Meta:
|
Meta:
|
||||||
$ref: "#/definitions/ResponseMeta"
|
$ref: "#/definitions/ResponseMeta"
|
||||||
type: object
|
type: object
|
||||||
FinancialStatement:
|
|
||||||
description: A financial statement for a company
|
|
||||||
properties:
|
|
||||||
AccessNumber:
|
|
||||||
description: EDGAR Access Number
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AccountID:
|
|
||||||
description: Account ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CloudRevenue:
|
|
||||||
description: Cloud Revenue
|
|
||||||
type: number
|
|
||||||
x-nullable: true
|
|
||||||
CreatedByID:
|
|
||||||
description: Created By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedDate:
|
|
||||||
description: Created Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Description:
|
|
||||||
description: Description
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
EdgarURL:
|
|
||||||
description: EDGAR URL
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
FilingType:
|
|
||||||
description: Filing Type
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
GrossProfit:
|
|
||||||
description: Gross Profit
|
|
||||||
type: number
|
|
||||||
x-nullable: true
|
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
LastModifiedByID:
|
|
||||||
description: Last Modified By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedDate:
|
|
||||||
description: Last Modified Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
NetIncome:
|
|
||||||
description: Net Income
|
|
||||||
type: number
|
|
||||||
x-nullable: true
|
|
||||||
PeriodEndDate:
|
|
||||||
description: Period End Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
TotalRevenue:
|
|
||||||
description: Total Revenue
|
|
||||||
type: number
|
|
||||||
x-nullable: true
|
|
||||||
Year:
|
|
||||||
description: Year
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
type: object
|
|
||||||
FinancialStatementRequest:
|
FinancialStatementRequest:
|
||||||
description: An array of FinancialStatement objects submitted for processing
|
description: An array of FinancialStatement objects submitted for processing
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/FinancialStatement"
|
$ref: "../../lib/swagger/defs/financial-statement.yaml#/FinancialStatement"
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
FinancialStatementResponse:
|
FinancialStatementResponse:
|
||||||
|
@ -1639,136 +1249,17 @@ definitions:
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/FinancialStatement"
|
$ref: "../../lib/swagger/defs/financial-statement.yaml#/FinancialStatement"
|
||||||
type: array
|
type: array
|
||||||
Meta:
|
Meta:
|
||||||
$ref: "#/definitions/ResponseMeta"
|
$ref: "#/definitions/ResponseMeta"
|
||||||
type: object
|
type: object
|
||||||
Industry:
|
|
||||||
description: An industry that is being researched
|
|
||||||
properties:
|
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
CompanyProducts:
|
|
||||||
description: The list of Products in this industry
|
|
||||||
items:
|
|
||||||
$ref: "#/definitions/CompanyProduct"
|
|
||||||
type: array
|
|
||||||
x-nullable: true
|
|
||||||
CompanyServices:
|
|
||||||
description: The list of Services in this industry
|
|
||||||
items:
|
|
||||||
$ref: "#/definitions/CompanyService"
|
|
||||||
type: array
|
|
||||||
x-nullable: true
|
|
||||||
CreatedByID:
|
|
||||||
description: Created By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedDate:
|
|
||||||
description: Created Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Description:
|
|
||||||
description: Industry Description
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
FullDescription:
|
|
||||||
description: Full Description
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ImageAltText:
|
|
||||||
description: Image Alt Text
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ImageURL:
|
|
||||||
description: Image URL
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedByID:
|
|
||||||
description: Last Modified By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedDate:
|
|
||||||
description: Last Modified Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Level:
|
|
||||||
description: The hierarchical level of this Industry
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Logo:
|
|
||||||
description: Logo
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Name:
|
|
||||||
description: Industry Name
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ParentIndustryID:
|
|
||||||
description: The ID of the Parent Industry
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Path:
|
|
||||||
description: The full path of this industry, including Parent
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ProductCategory:
|
|
||||||
description: Is this industry a product category?
|
|
||||||
type: boolean
|
|
||||||
x-nullable: true
|
|
||||||
ServiceCategory:
|
|
||||||
description: Is this industry a service category?
|
|
||||||
type: boolean
|
|
||||||
x-nullable: true
|
|
||||||
Slug:
|
|
||||||
description: The CMS Slug for this Industry
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
TagLine:
|
|
||||||
description: TagLine
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
type: object
|
|
||||||
IndustryCompany:
|
|
||||||
description: Junction object between Industry and Company
|
|
||||||
properties:
|
|
||||||
CompanyID:
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedByID:
|
|
||||||
description: Created By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedDate:
|
|
||||||
description: Created Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
IndustryID:
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedByID:
|
|
||||||
description: Last Modified By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedDate:
|
|
||||||
description: Last Modified Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Path:
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
type: object
|
|
||||||
IndustryCompanyRequest:
|
IndustryCompanyRequest:
|
||||||
description: An array of IndustryCompany objects submitted for processing
|
description: An array of IndustryCompany objects submitted for processing
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/IndustryCompany"
|
$ref: "../../lib/swagger/defs/industry-company.yaml#/IndustryCompany"
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
IndustryCompanyResponse:
|
IndustryCompanyResponse:
|
||||||
|
@ -1776,49 +1267,17 @@ definitions:
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/IndustryCompany"
|
$ref: "../../lib/swagger/defs/industry-company.yaml#/IndustryCompany"
|
||||||
type: array
|
type: array
|
||||||
Meta:
|
Meta:
|
||||||
$ref: "#/definitions/ResponseMeta"
|
$ref: "#/definitions/ResponseMeta"
|
||||||
type: object
|
type: object
|
||||||
IndustryProduct:
|
|
||||||
description: Junction object between Industry and CompanyProduct
|
|
||||||
properties:
|
|
||||||
CompanyProductID:
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedByID:
|
|
||||||
description: Created By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedDate:
|
|
||||||
description: Created Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
HTML:
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
IndustryID:
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedByID:
|
|
||||||
description: Last Modified By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedDate:
|
|
||||||
description: Last Modified Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
type: object
|
|
||||||
IndustryProductRequest:
|
IndustryProductRequest:
|
||||||
description: An array of IndustryProduct objects submitted for processing
|
description: An array of IndustryProduct objects submitted for processing
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/IndustryProduct"
|
$ref: "../../lib/swagger/defs/industry-product.yaml#/IndustryProduct"
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
IndustryProductResponse:
|
IndustryProductResponse:
|
||||||
|
@ -1826,50 +1285,17 @@ definitions:
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/IndustryProduct"
|
$ref: "../../lib/swagger/defs/industry-product.yaml#/IndustryProduct"
|
||||||
type: array
|
type: array
|
||||||
Meta:
|
Meta:
|
||||||
$ref: "#/definitions/ResponseMeta"
|
$ref: "#/definitions/ResponseMeta"
|
||||||
type: object
|
type: object
|
||||||
IndustryService:
|
|
||||||
description: Junction Object bewtwen Industry and CompanyService
|
|
||||||
properties:
|
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
CompanyService:
|
|
||||||
$ref: "#/definitions/CompanyService"
|
|
||||||
CompanyServiceID:
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedByID:
|
|
||||||
description: Created By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedDate:
|
|
||||||
description: Created Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Industry:
|
|
||||||
$ref: "#/definitions/Industry"
|
|
||||||
IndustryID:
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedByID:
|
|
||||||
description: Last Modified By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedDate:
|
|
||||||
description: Last Modified Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
type: object
|
|
||||||
IndustryServiceRequest:
|
IndustryServiceRequest:
|
||||||
description: An array of IndustryService objects submitted for processing
|
description: An array of IndustryService objects submitted for processing
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/IndustryService"
|
$ref: "../../lib/swagger/defs/industry-service.yaml#/IndustryService"
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
IndustryServiceResponse:
|
IndustryServiceResponse:
|
||||||
|
@ -1877,7 +1303,7 @@ definitions:
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/IndustryService"
|
$ref: "../../lib/swagger/defs/industry-service.yaml#/IndustryService"
|
||||||
type: array
|
type: array
|
||||||
Meta:
|
Meta:
|
||||||
$ref: "#/definitions/ResponseMeta"
|
$ref: "#/definitions/ResponseMeta"
|
||||||
|
@ -1887,7 +1313,7 @@ definitions:
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/Industry"
|
$ref: "../../lib/swagger/defs/industry.yaml#/Industry"
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
IndustryResponse:
|
IndustryResponse:
|
||||||
|
@ -1895,7 +1321,7 @@ definitions:
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/Industry"
|
$ref: "../../lib/swagger/defs/industry.yaml#/Industry"
|
||||||
type: array
|
type: array
|
||||||
Meta:
|
Meta:
|
||||||
$ref: "#/definitions/ResponseMeta"
|
$ref: "#/definitions/ResponseMeta"
|
||||||
|
@ -1919,59 +1345,12 @@ definitions:
|
||||||
format: int64
|
format: int64
|
||||||
type: number
|
type: number
|
||||||
type: object
|
type: object
|
||||||
Observation:
|
|
||||||
description: A data point collected while analyzing a Factor
|
|
||||||
properties:
|
|
||||||
AccountID:
|
|
||||||
description: The ID of the Company being analyzed
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CompanyProductID:
|
|
||||||
description: The ID of the Product being analyzed
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedByID:
|
|
||||||
description: Created By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedDate:
|
|
||||||
description: Created Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Description:
|
|
||||||
description: Notes concerning data collection
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
FactorID:
|
|
||||||
description: The ID of the Factor that owns this Observation
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
LastModifiedByID:
|
|
||||||
description: Last Modified By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedDate:
|
|
||||||
description: Last Modified Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
SubjectType:
|
|
||||||
description: Is the subject a Company or a Product?
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Value:
|
|
||||||
description: The data point collected
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
type: object
|
|
||||||
ObservationRequest:
|
ObservationRequest:
|
||||||
description: An array of Observation objects submitted for processing
|
description: An array of Observation objects submitted for processing
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/Observation"
|
$ref: "../../lib/swagger/defs/observation.yaml#/Observation"
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
ObservationResponse:
|
ObservationResponse:
|
||||||
|
@ -1979,7 +1358,7 @@ definitions:
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/Observation"
|
$ref: "../../lib/swagger/defs/observation.yaml#/Observation"
|
||||||
type: array
|
type: array
|
||||||
Meta:
|
Meta:
|
||||||
$ref: "#/definitions/ResponseMeta"
|
$ref: "#/definitions/ResponseMeta"
|
||||||
|
@ -2045,57 +1424,12 @@ definitions:
|
||||||
description: Account Number used for recording transactions
|
description: Account Number used for recording transactions
|
||||||
type: string
|
type: string
|
||||||
type: object
|
type: object
|
||||||
Topic:
|
|
||||||
description: A research topic that collects data
|
|
||||||
properties:
|
|
||||||
CreatedByID:
|
|
||||||
description: Created By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedDate:
|
|
||||||
description: Created Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Description:
|
|
||||||
description: Topic Description
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Factors:
|
|
||||||
description: The list of Factors used to analyze this industry
|
|
||||||
items:
|
|
||||||
$ref: "#/definitions/Factor"
|
|
||||||
type: array
|
|
||||||
x-nullable: true
|
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
LastModifiedByID:
|
|
||||||
description: Last Modified By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedDate:
|
|
||||||
description: Last Modified Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Name:
|
|
||||||
description: Topic Name
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ParentTopicID:
|
|
||||||
description: The ID of the Parent Topic
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Slug:
|
|
||||||
description: The CMS Slug for this Topic
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
type: object
|
|
||||||
TopicRequest:
|
TopicRequest:
|
||||||
description: An array of Topic objects submitted for processing
|
description: An array of Topic objects submitted for processing
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/Topic"
|
$ref: "../../lib/swagger/defs/topic.yaml#/Topic"
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
TopicResponse:
|
TopicResponse:
|
||||||
|
@ -2103,7 +1437,7 @@ definitions:
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/Topic"
|
$ref: "../../lib/swagger/defs/topic.yaml#/Topic"
|
||||||
type: array
|
type: array
|
||||||
Meta:
|
Meta:
|
||||||
$ref: "#/definitions/ResponseMeta"
|
$ref: "#/definitions/ResponseMeta"
|
||||||
|
|
|
@ -1151,36 +1151,7 @@ paths:
|
||||||
|
|
||||||
definitions:
|
definitions:
|
||||||
Address:
|
Address:
|
||||||
properties:
|
$ref: "../../lib/swagger/defs/address.yaml#/Address"
|
||||||
City:
|
|
||||||
description: City
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Country:
|
|
||||||
description: Country full name
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CountryCode:
|
|
||||||
description: Country Code
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
PostalCode:
|
|
||||||
description: Postal Code
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
State:
|
|
||||||
description: State full name
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
StateCode:
|
|
||||||
description: State Code
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Street:
|
|
||||||
description: Street number and name
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
type: object
|
|
||||||
CompanyCategory:
|
CompanyCategory:
|
||||||
properties:
|
properties:
|
||||||
CloudType:
|
CloudType:
|
||||||
|
@ -1200,137 +1171,12 @@ definitions:
|
||||||
Meta:
|
Meta:
|
||||||
$ref: "#/definitions/ResponseMeta"
|
$ref: "#/definitions/ResponseMeta"
|
||||||
type: object
|
type: object
|
||||||
CompanyProduct:
|
|
||||||
description: A software product or service vended by a Company
|
|
||||||
properties:
|
|
||||||
AccountID:
|
|
||||||
description: ID of the Company that owns this Product
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AccountNumber:
|
|
||||||
description: Account Number
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AccountName:
|
|
||||||
description: Account Name
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AccountPublish:
|
|
||||||
description: Account Publish
|
|
||||||
type: boolean
|
|
||||||
x-nullable: true
|
|
||||||
AccountWebsite:
|
|
||||||
description: Account Website
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AccountEmail:
|
|
||||||
description: Account Email
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AccountLogo:
|
|
||||||
description: Account Logo
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AccountSlug:
|
|
||||||
description: Account Slug
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AppExchange:
|
|
||||||
description: Salesforce AppExchange URL
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedByID:
|
|
||||||
description: Created By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedDate:
|
|
||||||
description: Created Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Description:
|
|
||||||
description: Description of product
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
EnrichmentStatus:
|
|
||||||
description: Enrichment Status
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
FullDescription:
|
|
||||||
description: Full Description of product
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
ImageAltText:
|
|
||||||
description: Image Alt Text
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ImageURL:
|
|
||||||
description: Image URL
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Industries:
|
|
||||||
description: Industries
|
|
||||||
items:
|
|
||||||
$ref: "#/definitions/Industry"
|
|
||||||
type: array
|
|
||||||
x-nullable: true
|
|
||||||
LastEnrichedByID:
|
|
||||||
description: Last Enriched By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastEnrichmentDate:
|
|
||||||
description: Last Enriched Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedByID:
|
|
||||||
description: Last Modified By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedDate:
|
|
||||||
description: Last Modified Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Logo:
|
|
||||||
description: Logo
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Name:
|
|
||||||
description: Product Name
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ProductVideoID:
|
|
||||||
description: Product Video ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Published:
|
|
||||||
description: Published
|
|
||||||
type: boolean
|
|
||||||
x-nullable: true
|
|
||||||
SalesforceSpecific:
|
|
||||||
description: Salesforce Specific
|
|
||||||
type: boolean
|
|
||||||
x-nullable: true
|
|
||||||
Slug:
|
|
||||||
description: Slug
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
TagLine:
|
|
||||||
description: TagLine
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
URL:
|
|
||||||
description: Website
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
type: object
|
|
||||||
CompanyProductRequest:
|
CompanyProductRequest:
|
||||||
description: An array of CompanyProduct objects submitted for processing
|
description: An array of CompanyProduct objects submitted for processing
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/CompanyProduct"
|
$ref: "../../lib/swagger/defs/company-product.yaml#/CompanyProduct"
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
CompanyProductResponse:
|
CompanyProductResponse:
|
||||||
|
@ -1338,141 +1184,17 @@ definitions:
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/CompanyProduct"
|
$ref: "../../lib/swagger/defs/company-product.yaml#/CompanyProduct"
|
||||||
type: array
|
type: array
|
||||||
Meta:
|
Meta:
|
||||||
$ref: "#/definitions/ResponseMeta"
|
$ref: "#/definitions/ResponseMeta"
|
||||||
type: object
|
type: object
|
||||||
CompanyService:
|
|
||||||
description: A service performed by a Company
|
|
||||||
properties:
|
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
AccountID:
|
|
||||||
description: ID of the Company that owns this Service
|
|
||||||
type: string
|
|
||||||
AccountNumber:
|
|
||||||
description: Account Number
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AccountName:
|
|
||||||
description: Account Name
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AccountPublish:
|
|
||||||
description: Account Publish
|
|
||||||
type: boolean
|
|
||||||
x-nullable: true
|
|
||||||
AccountWebsite:
|
|
||||||
description: Account Website
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AccountEmail:
|
|
||||||
description: Account Email
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AccountLogo:
|
|
||||||
description: Account Logo
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AccountSlug:
|
|
||||||
description: Account Slug
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AppExchange:
|
|
||||||
description: Salesforce AppExchange URL
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedByID:
|
|
||||||
description: Created By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedDate:
|
|
||||||
description: Created Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Description:
|
|
||||||
description: Description of service
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
EnrichmentStatus:
|
|
||||||
description: Enrichment Status
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
FullDescription:
|
|
||||||
description: Full Description of service
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ImageAltText:
|
|
||||||
description: Image Alt Text
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ImageURL:
|
|
||||||
description: Image URL
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Industries:
|
|
||||||
description: Industries
|
|
||||||
items:
|
|
||||||
$ref: "#/definitions/Industry"
|
|
||||||
type: array
|
|
||||||
x-nullable: true
|
|
||||||
LastEnrichedByID:
|
|
||||||
description: Last Enriched By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastEnrichmentDate:
|
|
||||||
description: Last Enriched Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedByID:
|
|
||||||
description: Last Modified By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedDate:
|
|
||||||
description: Last Modified Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Logo:
|
|
||||||
description: Logo
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Name:
|
|
||||||
description: Service Name
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Published:
|
|
||||||
description: Published
|
|
||||||
type: boolean
|
|
||||||
x-nullable: true
|
|
||||||
SalesforceSpecific:
|
|
||||||
description: Salesforce Specific
|
|
||||||
type: boolean
|
|
||||||
x-nullable: true
|
|
||||||
ServiceVideoID:
|
|
||||||
description: Service Video ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Slug:
|
|
||||||
description: Slug
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
TagLine:
|
|
||||||
description: Tag Line
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
URL:
|
|
||||||
description: URL
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
type: object
|
|
||||||
CompanyServiceRequest:
|
CompanyServiceRequest:
|
||||||
description: An array of CompanyService objects submitted for processing
|
description: An array of CompanyService objects submitted for processing
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/CompanyService"
|
$ref: "../../lib/swagger/defs/company-service.yaml#/CompanyService"
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
CompanyServiceResponse:
|
CompanyServiceResponse:
|
||||||
|
@ -1480,7 +1202,7 @@ definitions:
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/CompanyService"
|
$ref: "../../lib/swagger/defs/company-service.yaml#/CompanyService"
|
||||||
type: array
|
type: array
|
||||||
Meta:
|
Meta:
|
||||||
$ref: "#/definitions/ResponseMeta"
|
$ref: "#/definitions/ResponseMeta"
|
||||||
|
@ -1496,57 +1218,12 @@ definitions:
|
||||||
type: object
|
type: object
|
||||||
Error:
|
Error:
|
||||||
$ref: ../../lib/swagger/defs/error.yaml#/Error
|
$ref: ../../lib/swagger/defs/error.yaml#/Error
|
||||||
Factor:
|
|
||||||
description: A Factor of analysis within a research topic
|
|
||||||
properties:
|
|
||||||
CreatedByID:
|
|
||||||
description: Created By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedDate:
|
|
||||||
description: Created Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Description:
|
|
||||||
description: Topic Description
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
LastModifiedByID:
|
|
||||||
description: Last Modified By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedDate:
|
|
||||||
description: Last Modified Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Name:
|
|
||||||
description: Factor Name
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Observations:
|
|
||||||
description: The list of Observations used to analyze this industry
|
|
||||||
items:
|
|
||||||
$ref: "#/definitions/Observation"
|
|
||||||
type: array
|
|
||||||
x-nullable: true
|
|
||||||
Slug:
|
|
||||||
description: The slug of the corresponding page on the CMS
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
TopicID:
|
|
||||||
description: The ID of the Topic that owns this Factor
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
type: object
|
|
||||||
FactorRequest:
|
FactorRequest:
|
||||||
description: An array of Factor objects submitted for processing
|
description: An array of Factor objects submitted for processing
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/Factor"
|
$ref: "../../lib/swagger/defs/factor.yaml#/Factor"
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
FactorResponse:
|
FactorResponse:
|
||||||
|
@ -1554,84 +1231,17 @@ definitions:
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/Factor"
|
$ref: "../../lib/swagger/defs/factor.yaml#/Factor"
|
||||||
type: array
|
type: array
|
||||||
Meta:
|
Meta:
|
||||||
$ref: "#/definitions/ResponseMeta"
|
$ref: "#/definitions/ResponseMeta"
|
||||||
type: object
|
type: object
|
||||||
FinancialStatement:
|
|
||||||
description: A financial statement for a company
|
|
||||||
properties:
|
|
||||||
AccessNumber:
|
|
||||||
description: EDGAR Access Number
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
AccountID:
|
|
||||||
description: Account ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CloudRevenue:
|
|
||||||
description: Cloud Revenue
|
|
||||||
type: number
|
|
||||||
x-nullable: true
|
|
||||||
CreatedByID:
|
|
||||||
description: Created By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedDate:
|
|
||||||
description: Created Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Description:
|
|
||||||
description: Description
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
EdgarURL:
|
|
||||||
description: EDGAR URL
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
FilingType:
|
|
||||||
description: Filing Type
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
GrossProfit:
|
|
||||||
description: Gross Profit
|
|
||||||
type: number
|
|
||||||
x-nullable: true
|
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
LastModifiedByID:
|
|
||||||
description: Last Modified By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedDate:
|
|
||||||
description: Last Modified Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
NetIncome:
|
|
||||||
description: Net Income
|
|
||||||
type: number
|
|
||||||
x-nullable: true
|
|
||||||
PeriodEndDate:
|
|
||||||
description: Period End Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
TotalRevenue:
|
|
||||||
description: Total Revenue
|
|
||||||
type: number
|
|
||||||
x-nullable: true
|
|
||||||
Year:
|
|
||||||
description: Year
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
type: object
|
|
||||||
FinancialStatementRequest:
|
FinancialStatementRequest:
|
||||||
description: An array of FinancialStatement objects submitted for processing
|
description: An array of FinancialStatement objects submitted for processing
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/FinancialStatement"
|
$ref: "../../lib/swagger/defs/financial-statement.yaml#/FinancialStatement"
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
FinancialStatementResponse:
|
FinancialStatementResponse:
|
||||||
|
@ -1639,136 +1249,17 @@ definitions:
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/FinancialStatement"
|
$ref: "../../lib/swagger/defs/financial-statement.yaml#/FinancialStatement"
|
||||||
type: array
|
type: array
|
||||||
Meta:
|
Meta:
|
||||||
$ref: "#/definitions/ResponseMeta"
|
$ref: "#/definitions/ResponseMeta"
|
||||||
type: object
|
type: object
|
||||||
Industry:
|
|
||||||
description: An industry that is being researched
|
|
||||||
properties:
|
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
CompanyProducts:
|
|
||||||
description: The list of Products in this industry
|
|
||||||
items:
|
|
||||||
$ref: "#/definitions/CompanyProduct"
|
|
||||||
type: array
|
|
||||||
x-nullable: true
|
|
||||||
CompanyServices:
|
|
||||||
description: The list of Services in this industry
|
|
||||||
items:
|
|
||||||
$ref: "#/definitions/CompanyService"
|
|
||||||
type: array
|
|
||||||
x-nullable: true
|
|
||||||
CreatedByID:
|
|
||||||
description: Created By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedDate:
|
|
||||||
description: Created Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Description:
|
|
||||||
description: Industry Description
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
FullDescription:
|
|
||||||
description: Full Description
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ImageAltText:
|
|
||||||
description: Image Alt Text
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ImageURL:
|
|
||||||
description: Image URL
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedByID:
|
|
||||||
description: Last Modified By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedDate:
|
|
||||||
description: Last Modified Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Level:
|
|
||||||
description: The hierarchical level of this Industry
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Logo:
|
|
||||||
description: Logo
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Name:
|
|
||||||
description: Industry Name
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ParentIndustryID:
|
|
||||||
description: The ID of the Parent Industry
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Path:
|
|
||||||
description: The full path of this industry, including Parent
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ProductCategory:
|
|
||||||
description: Is this industry a product category?
|
|
||||||
type: boolean
|
|
||||||
x-nullable: true
|
|
||||||
ServiceCategory:
|
|
||||||
description: Is this industry a service category?
|
|
||||||
type: boolean
|
|
||||||
x-nullable: true
|
|
||||||
Slug:
|
|
||||||
description: The CMS Slug for this Industry
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
TagLine:
|
|
||||||
description: TagLine
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
type: object
|
|
||||||
IndustryCompany:
|
|
||||||
description: Junction object between Industry and Company
|
|
||||||
properties:
|
|
||||||
CompanyID:
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedByID:
|
|
||||||
description: Created By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedDate:
|
|
||||||
description: Created Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
IndustryID:
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedByID:
|
|
||||||
description: Last Modified By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedDate:
|
|
||||||
description: Last Modified Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Path:
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
type: object
|
|
||||||
IndustryCompanyRequest:
|
IndustryCompanyRequest:
|
||||||
description: An array of IndustryCompany objects submitted for processing
|
description: An array of IndustryCompany objects submitted for processing
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/IndustryCompany"
|
$ref: "../../lib/swagger/defs/industry-company.yaml#/IndustryCompany"
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
IndustryCompanyResponse:
|
IndustryCompanyResponse:
|
||||||
|
@ -1776,49 +1267,17 @@ definitions:
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/IndustryCompany"
|
$ref: "../../lib/swagger/defs/industry-company.yaml#/IndustryCompany"
|
||||||
type: array
|
type: array
|
||||||
Meta:
|
Meta:
|
||||||
$ref: "#/definitions/ResponseMeta"
|
$ref: "#/definitions/ResponseMeta"
|
||||||
type: object
|
type: object
|
||||||
IndustryProduct:
|
|
||||||
description: Junction object between Industry and CompanyProduct
|
|
||||||
properties:
|
|
||||||
CompanyProductID:
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedByID:
|
|
||||||
description: Created By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedDate:
|
|
||||||
description: Created Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
HTML:
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
IndustryID:
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedByID:
|
|
||||||
description: Last Modified By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedDate:
|
|
||||||
description: Last Modified Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
type: object
|
|
||||||
IndustryProductRequest:
|
IndustryProductRequest:
|
||||||
description: An array of IndustryProduct objects submitted for processing
|
description: An array of IndustryProduct objects submitted for processing
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/IndustryProduct"
|
$ref: "../../lib/swagger/defs/industry-product.yaml#/IndustryProduct"
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
IndustryProductResponse:
|
IndustryProductResponse:
|
||||||
|
@ -1826,50 +1285,17 @@ definitions:
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/IndustryProduct"
|
$ref: "../../lib/swagger/defs/industry-product.yaml#/IndustryProduct"
|
||||||
type: array
|
type: array
|
||||||
Meta:
|
Meta:
|
||||||
$ref: "#/definitions/ResponseMeta"
|
$ref: "#/definitions/ResponseMeta"
|
||||||
type: object
|
type: object
|
||||||
IndustryService:
|
|
||||||
description: Junction Object bewtwen Industry and CompanyService
|
|
||||||
properties:
|
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
CompanyService:
|
|
||||||
$ref: "#/definitions/CompanyService"
|
|
||||||
CompanyServiceID:
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedByID:
|
|
||||||
description: Created By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedDate:
|
|
||||||
description: Created Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Industry:
|
|
||||||
$ref: "#/definitions/Industry"
|
|
||||||
IndustryID:
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedByID:
|
|
||||||
description: Last Modified By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedDate:
|
|
||||||
description: Last Modified Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
type: object
|
|
||||||
IndustryServiceRequest:
|
IndustryServiceRequest:
|
||||||
description: An array of IndustryService objects submitted for processing
|
description: An array of IndustryService objects submitted for processing
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/IndustryService"
|
$ref: "../../lib/swagger/defs/industry-service.yaml#/IndustryService"
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
IndustryServiceResponse:
|
IndustryServiceResponse:
|
||||||
|
@ -1877,7 +1303,7 @@ definitions:
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/IndustryService"
|
$ref: "../../lib/swagger/defs/industry-service.yaml#/IndustryService"
|
||||||
type: array
|
type: array
|
||||||
Meta:
|
Meta:
|
||||||
$ref: "#/definitions/ResponseMeta"
|
$ref: "#/definitions/ResponseMeta"
|
||||||
|
@ -1887,7 +1313,7 @@ definitions:
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/Industry"
|
$ref: "../../lib/swagger/defs/industry.yaml#/Industry"
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
IndustryResponse:
|
IndustryResponse:
|
||||||
|
@ -1895,7 +1321,7 @@ definitions:
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/Industry"
|
$ref: "../../lib/swagger/defs/industry.yaml#/Industry"
|
||||||
type: array
|
type: array
|
||||||
Meta:
|
Meta:
|
||||||
$ref: "#/definitions/ResponseMeta"
|
$ref: "#/definitions/ResponseMeta"
|
||||||
|
@ -1919,59 +1345,12 @@ definitions:
|
||||||
format: int64
|
format: int64
|
||||||
type: number
|
type: number
|
||||||
type: object
|
type: object
|
||||||
Observation:
|
|
||||||
description: A data point collected while analyzing a Factor
|
|
||||||
properties:
|
|
||||||
AccountID:
|
|
||||||
description: The ID of the Company being analyzed
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CompanyProductID:
|
|
||||||
description: The ID of the Product being analyzed
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedByID:
|
|
||||||
description: Created By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedDate:
|
|
||||||
description: Created Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Description:
|
|
||||||
description: Notes concerning data collection
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
FactorID:
|
|
||||||
description: The ID of the Factor that owns this Observation
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
LastModifiedByID:
|
|
||||||
description: Last Modified By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedDate:
|
|
||||||
description: Last Modified Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
SubjectType:
|
|
||||||
description: Is the subject a Company or a Product?
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Value:
|
|
||||||
description: The data point collected
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
type: object
|
|
||||||
ObservationRequest:
|
ObservationRequest:
|
||||||
description: An array of Observation objects submitted for processing
|
description: An array of Observation objects submitted for processing
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/Observation"
|
$ref: "../../lib/swagger/defs/observation.yaml#/Observation"
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
ObservationResponse:
|
ObservationResponse:
|
||||||
|
@ -1979,7 +1358,7 @@ definitions:
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/Observation"
|
$ref: "../../lib/swagger/defs/observation.yaml#/Observation"
|
||||||
type: array
|
type: array
|
||||||
Meta:
|
Meta:
|
||||||
$ref: "#/definitions/ResponseMeta"
|
$ref: "#/definitions/ResponseMeta"
|
||||||
|
@ -2045,57 +1424,12 @@ definitions:
|
||||||
description: Account Number used for recording transactions
|
description: Account Number used for recording transactions
|
||||||
type: string
|
type: string
|
||||||
type: object
|
type: object
|
||||||
Topic:
|
|
||||||
description: A research topic that collects data
|
|
||||||
properties:
|
|
||||||
CreatedByID:
|
|
||||||
description: Created By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
CreatedDate:
|
|
||||||
description: Created Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Description:
|
|
||||||
description: Topic Description
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Factors:
|
|
||||||
description: The list of Factors used to analyze this industry
|
|
||||||
items:
|
|
||||||
$ref: "#/definitions/Factor"
|
|
||||||
type: array
|
|
||||||
x-nullable: true
|
|
||||||
ID:
|
|
||||||
description: Record Id
|
|
||||||
type: string
|
|
||||||
LastModifiedByID:
|
|
||||||
description: Last Modified By User ID
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
LastModifiedDate:
|
|
||||||
description: Last Modified Date
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Name:
|
|
||||||
description: Topic Name
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
ParentTopicID:
|
|
||||||
description: The ID of the Parent Topic
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
Slug:
|
|
||||||
description: The CMS Slug for this Topic
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
type: object
|
|
||||||
TopicRequest:
|
TopicRequest:
|
||||||
description: An array of Topic objects submitted for processing
|
description: An array of Topic objects submitted for processing
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/Topic"
|
$ref: "../../lib/swagger/defs/topic.yaml#/Topic"
|
||||||
type: array
|
type: array
|
||||||
type: object
|
type: object
|
||||||
TopicResponse:
|
TopicResponse:
|
||||||
|
@ -2103,7 +1437,7 @@ definitions:
|
||||||
properties:
|
properties:
|
||||||
Data:
|
Data:
|
||||||
items:
|
items:
|
||||||
$ref: "#/definitions/Topic"
|
$ref: "../../lib/swagger/defs/topic.yaml#/Topic"
|
||||||
type: array
|
type: array
|
||||||
Meta:
|
Meta:
|
||||||
$ref: "#/definitions/ResponseMeta"
|
$ref: "#/definitions/ResponseMeta"
|
||||||
|
|
Loading…
Reference in New Issue