API Dashboard

Taffy 3.6.0

Resources:

trendsyears DELETE PATCH PUT POST GET /trends/yearly

Request Body:

Loading...

Response:

get
Returns a paged resultset of sector trends over the years
optional numeric offset (default: 0)
optional numeric limit (default: 10)
optional string sort (default: "")

Comma seperated list of sorting conditions in the format 'col1:asc,col2:desc'

trendsindustriessubsectorsprojectscollection DELETE PATCH PUT POST GET /trends/subsectors/projects

Request Body:

Loading...

Response:

get
Returns a paged resultset of trends
optional numeric offset (default: 0)
optional numeric limit (default: 10)
optional string searchString (default: "")
optional string sort (default: "")

Comma seperated list of sorting conditions in the format 'col1:asc,col2:desc'

trendsindustriessubsectorsjobscollection DELETE PATCH PUT POST GET /trends/subsectors/jobs

Request Body:

Loading...

Response:

get
Returns a paged resultset of trends
optional numeric offset (default: 0)
optional numeric limit (default: 10)
optional string searchString (default: "")
optional string sort (default: "")

Comma seperated list of sorting conditions in the format 'col1:asc,col2:desc'

trendsindustriessubsectorsinvestmentcollection DELETE PATCH PUT POST GET /trends/subsectors/investments

Request Body:

Loading...

Response:

get
Returns a paged resultset of trends
optional numeric offset (default: 0)
optional numeric limit (default: 10)
optional string searchString (default: "")
optional string sort (default: "")

Comma seperated list of sorting conditions in the format 'col1:asc,col2:desc'

trendsindustriessectorspivotprojectscollection DELETE PATCH PUT POST GET /trends/sectors/projects

Request Body:

Loading...

Response:

get
Returns a paged resultset of trends
optional numeric offset (default: 0)
optional numeric limit (default: 10)
optional string searchString (default: "")
optional string sort (default: "")

Comma seperated list of sorting conditions in the format 'col1:asc,col2:desc'

trendsindustriessectorspivotjobscollection DELETE PATCH PUT POST GET /trends/sectors/jobs

Request Body:

Loading...

Response:

get
Returns job trends by year for each sector
optional numeric offset (default: 0)
optional numeric limit (default: 10)
optional string searchString (default: "")
optional string sort (default: "")

Comma seperated list of sorting conditions in the format 'col1:asc,col2:desc'

trendsindustriessectorspivotinvestmentcollection DELETE PATCH PUT POST GET /trends/sectors/investments

Request Body:

Loading...

Response:

get
Returns a paged resultset of trends
optional numeric offset (default: 0)
optional numeric limit (default: 10)
optional string searchString (default: "")
optional string sort (default: "")

Comma seperated list of sorting conditions in the format 'col1:asc,col2:desc'

trendsindustriessectorscollection DELETE PATCH PUT POST GET /trends/sectors

Request Body:

Loading...

Response:

get
Returns a paged yearly resultset of sector trends
optional numeric offset (default: 0)
optional numeric limit (default: 10)
optional string searchString (default: "")
optional string sort (default: "")

Comma seperated list of sorting conditions in the format 'col1:asc,col2:desc'

trendsindustriesclustersprojectscollection DELETE PATCH PUT POST GET /trends/clusters/projects

Request Body:

Loading...

Response:

get
Returns a paged resultset of trends
optional numeric offset (default: 0)
optional numeric limit (default: 10)
optional string searchString (default: "")
optional string sort (default: "")

Comma seperated list of sorting conditions in the format 'col1:asc,col2:desc'

trendsindustriesclustersjobscollection DELETE PATCH PUT POST GET /trends/clusters/jobs

Request Body:

Loading...

Response:

get
Returns a paged resultset of trends
optional numeric offset (default: 0)
optional numeric limit (default: 10)
optional string searchString (default: "")
optional string sort (default: "")

Comma seperated list of sorting conditions in the format 'col1:asc,col2:desc'

trendsindustriesclustersinvestmentcollection DELETE PATCH PUT POST GET /trends/clusters/investments

Request Body:

Loading...

Response:

get
Returns a paged resultset of trends
optional numeric offset (default: 0)
optional numeric limit (default: 10)
optional string searchString (default: "")
optional string sort (default: "")

Comma seperated list of sorting conditions in the format 'col1:asc,col2:desc'

trendsindustriesbusinessfunctionsprojectscollection DELETE PATCH PUT POST GET /trends/businessfunctions/projects

Request Body:

Loading...

Response:

get
Returns a paged resultset of trends
optional numeric offset (default: 0)
optional numeric limit (default: 10)
optional string searchString (default: "")
optional string sort (default: "")

Comma seperated list of sorting conditions in the format 'col1:asc,col2:desc'

trendsindustriesbusinessfunctionsjobscollection DELETE PATCH PUT POST GET /trends/businessfunctions/jobs

Request Body:

Loading...

Response:

get
Returns a paged resultset of trends
optional numeric offset (default: 0)
optional numeric limit (default: 10)
optional string searchString (default: "")
optional string sort (default: "")

Comma seperated list of sorting conditions in the format 'col1:asc,col2:desc'

trendsindustriesbusinessfunctionsinvestmentcollection DELETE PATCH PUT POST GET /trends/businessfunctions/investments

Request Body:

Loading...

Response:

get
Returns a paged resultset of trends
optional numeric offset (default: 0)
optional numeric limit (default: 10)
optional string searchString (default: "")
optional string sort (default: "")

Comma seperated list of sorting conditions in the format 'col1:asc,col2:desc'

trendscollection DELETE PATCH PUT POST GET /trends

Request Body:

Loading...

Response:

get
Returns a paged resultset of trend overviews by year
optional numeric offset (default: 0)
optional numeric limit (default: 10)
optional string sort (default: "")

Comma seperated list of sorting conditions in the format 'col1:asc,col2:desc'

testerror DELETE PATCH PUT POST GET /testerror

Request Body:

Loading...

Response:

get
Test the error handler

testemail DELETE PATCH PUT POST GET /testemail

Request Body:

Loading...

Response:

get
Test the email service

tagsstatuses DELETE PATCH PUT POST GET /tagstatuses

Request Body:

Loading...

Response:

get
List all tag statuses available

tagscollection DELETE PATCH PUT POST GET /tags

Request Body:

Loading...

Response:

get
List all tags available

tagscategoriestags DELETE PATCH PUT POST GET /tagcategories/{id}/tags

URI Tokens: (required)

Request Body:

Loading...

Response:

get
List all tags available for the specified category
required numeric id

tagscategoriescategories DELETE PATCH PUT POST GET /tagcategories

Request Body:

Loading...

Response:

get
List all tag categories available

signalstypescollection DELETE PATCH PUT POST GET /signals/{id}/types

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Returns all types for a given signal
required numeric id

signalssectorscollection DELETE PATCH PUT POST GET /signals/{id}/sectors

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Returns all sectors for a given signal
required numeric id

signalsclusterscollection DELETE PATCH PUT POST GET /signals/{id}/clusters

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Returns all clusters for a given signal
required numeric id

signalsbusinessfunctionscollection DELETE PATCH PUT POST GET /signals/{id}/businessfunctions

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Returns all business functions for a given signal
required numeric id

signalsmember DELETE PATCH PUT POST GET /signals/{id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Returns a signal by id
required numeric id

signalscollection DELETE PATCH PUT POST GET /signals

Request Body:

Loading...

Response:

get
Returns a paged resultset of signals
optional numeric offset (default: 0)
optional numeric limit (default: 10)
optional string searchString (default: "")
optional string sort (default: "")

projectstypesmember DELETE PATCH PUT POST GET /projects/types/{id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Returns an project type by id
required numeric id

projectstypescollection DELETE PATCH PUT POST GET /projects/types

Request Body:

Loading...

Response:

get
List all project types

projectscount DELETE PATCH PUT POST GET /projects/count

Request Body:

Loading...

Response:

get
Returns a count fo all deals matching the specified filter set
optional numeric filterId (default: 0)

Id of a filter definition to apply to the returned deals data

projectsmotivescollection DELETE PATCH PUT POST GET /projects/{id}/motives

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Returns the motives for a specified project id
required numeric id

The project id

optional numeric version (default: 0)

The version number of the project record you wish to get the motives for. If 0 gets the most recent version number

optional numeric fdiId (default: 0)

The unique identifier of a project version in the system. Can be specified in place of the version number

projectsmember DELETE PATCH PUT POST GET /projects/{id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Returns a project record
required numeric id

projectscollection DELETE PATCH PUT POST GET /projects

Request Body:

Loading...

Response:

get
Returns a paged resultset of projects
optional numeric offset (default: 0)
optional numeric limit (default: 10)
optional string searchString (default: "")
optional string sort (default: "")

Comma seperated list of sorting conditions in the format 'col1:asc,col2:desc'

motivescollection DELETE PATCH PUT POST GET /motives

Request Body:

Loading...

Response:

get
List all motives available

industriessubsectorscollection DELETE PATCH PUT POST GET /industries/subsectors

Request Body:

Loading...

Response:

get
List all subsectors available

industriessectorssubsectors DELETE PATCH PUT POST GET /industries/sectors/{id}/subsectors

URI Tokens: (required)

Request Body:

Loading...

Response:

get
List all subsectors available in a given sector
required numeric id

industriessectorscollection DELETE PATCH PUT POST GET /industries/sectors

Request Body:

Loading...

Response:

get
List all sectors available

industriesnaicssubsectorscollection DELETE PATCH PUT POST GET /industries/naics/subsectors

Request Body:

Loading...

Response:

get
List all naics subsectors available

industriesnaicssectorscollection DELETE PATCH PUT POST GET /industries/naics/sectors

Request Body:

Loading...

Response:

get
List all naics sectors available

industriesnaicsindustriescollection DELETE PATCH PUT POST GET /industries/naics/industries

Request Body:

Loading...

Response:

get
List all naics industries available

industrieslegacysectorscollection DELETE PATCH PUT POST GET /industries/legacy/sectors

Request Body:

Loading...

Response:

get
List all legacy sectors available

industrieslegacybusinessfunctionscollection DELETE PATCH PUT POST GET /industries/legacy/businessfunctions

Request Body:

Loading...

Response:

get
List all legacy business functions available

industriesclusterscollection DELETE PATCH PUT POST GET /industries/clusters

Request Body:

Loading...

Response:

get
List all clusters available

industriesbusinessfunctionscollection DELETE PATCH PUT POST GET /industries/businessfunctions

Request Body:

Loading...

Response:

get
List all business functions available

incentivesflowmapscityrankingsdimensions DELETE PATCH PUT POST GET /incentivesflow/maps/cityrankings/dimensions

Request Body:

Loading...

Response:

get
Get the city ranking dimensions

incentivesflowmapscityrankings DELETE PATCH PUT POST GET /incentivesflow/maps/cityrankings

Request Body:

Loading...

Response:

get
Get the map feed for incentives flow
optional numeric filterId (default: 0)
optional numeric ranking (default: 100)
optional numeric stat_code (default: 1)

incentivesflowindustriessectorscollection DELETE PATCH PUT POST GET /incentivesflow/industries/sectors

Request Body:

Loading...

Response:

get
List all legacy sectors available

incentivesflowindustriesbusinessfunctionscollection DELETE PATCH PUT POST GET /incentivesflow/industries/businessfunctions

Request Body:

Loading...

Response:

get
List all legacy business functions available

filterscriteriagroupedcount DELETE PATCH PUT POST GET /incentivesflow/filters/criteria/groupedcount

Request Body:

Loading...

Response:

get
Returns a count for all projects matching the specified filter set for a given crioteria key and the associated list keys and values
optional numeric filterId (default: 0)
optional string group (default: "")

incentivestypesmember DELETE PATCH PUT POST GET /incentives/types/{id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Returns an incentive type by id
required numeric id

incentivestypescollection DELETE PATCH PUT POST GET /incentives/types

Request Body:

Loading...

Response:

get
List all incentives types

incentivesprogramsmember DELETE PATCH PUT POST GET /incentives/programs/{id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Returns an incentive program by id
required numeric id

incentivesprogramscollection DELETE PATCH PUT POST GET /incentives/programs

Request Body:

Loading...

Response:

get
Get all incentives programs paged

incentivesobjectivesmember DELETE PATCH PUT POST GET /incentives/objectives/{id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Returns an incentive objective by id
required numeric id

incentivesobjectivescollection DELETE PATCH PUT POST GET /incentives/objectives

Request Body:

Loading...

Response:

get
List all incentives categories

headcountbandscollection DELETE PATCH PUT POST GET /headcountbands

Request Body:

Loading...

Response:

get
List all headcount bands

geographyworldregionssubregionscollection DELETE PATCH PUT POST GET /geography/worldregions/{id}/subregions

URI Tokens: (required)

Request Body:

Loading...

Response:

get
List all sub regions available within a given world region
required numeric id

geographyworldregionsmember DELETE PATCH PUT POST GET /geography/worldregions/{id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Returns a world region by id
required numeric id

geographyworldregionscollection DELETE PATCH PUT POST GET /geography/worldregions

Request Body:

Loading...

Response:

get
List all world regions available

geographysubregionscountriescollection DELETE PATCH PUT POST GET /geography/subregions/{id}/countries

URI Tokens: (required)

Request Body:

Loading...

Response:

get
List all countries available within a given subregion
required numeric id

geographysubregionsmember DELETE PATCH PUT POST GET /geography/subregions/{id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Returns a sub region by id
required numeric id

geographysubregionscollection DELETE PATCH PUT POST GET /geography/subregions

Request Body:

Loading...

Response:

get
List all sub regions available

geographycountriesstatescitiescollection DELETE PATCH PUT POST GET /geography/countries/{countryId}/states/{stateId}/cities

URI Tokens: (required)

Request Body:

Loading...

Response:

get
List all cities inside a given state
required numeric countryId
required numeric stateId

geographycountriesstatescollection DELETE PATCH PUT POST GET /geography/countries/{id}/states

URI Tokens: (required)

Request Body:

Loading...

Response:

get
List all states available in a given country
required numeric id

geographycountriescitiescollection DELETE PATCH PUT POST GET /geography/countries/{id}/cities

URI Tokens: (required)

Request Body:

Loading...

Response:

get
List all cities within the specified country
required numeric id

geographycountriesadminregionscollection DELETE PATCH PUT POST GET /geography/countries/{id}/adminregions

URI Tokens: (required)

Request Body:

Loading...

Response:

get
List all admin regions within the specified country
required numeric id

geographycountriesmember DELETE PATCH PUT POST GET /geography/countries/{id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Returns a country by id
required numeric id

geographycountriescollection DELETE PATCH PUT POST GET /geography/countries

Request Body:

Loading...

Response:

get
List all countries available

geographycitiesmember DELETE PATCH PUT POST GET /geography/cities/{id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Returns a city by id
required numeric id

geographycitiescollection DELETE PATCH PUT POST GET /geography/cities

Request Body:

Loading...

Response:

get
List all cities available paged

filtersdefault DELETE PATCH PUT POST GET /filters/default

Request Body:

Loading...

Response:

get
Returns the users default filter

filtersmember DELETE PATCH PUT POST GET /filters/{id}

URI Tokens: (required)

Request Body:

Loading...

Response:

delete
Delete a given search definition
required numeric id
get
Returns a filter by its id
required numeric id
patch
Update the given filter
required numeric id

filterscollection DELETE PATCH PUT POST GET /filters

Request Body:

Loading...

Response:

get
Returns a paged resultset of search filters
optional numeric offset (default: 0)

Starting record index

optional numeric limit (default: 10)

Number of records to return from the offset up to a maximum of 100

optional string sort (default: "")

Comma seperated list of sorting conditions in the format 'col1:asc,col2:desc'

optional boolean list (default: false)
post
Creates a search definition
optional struct definition (default: [runtime expression])

validate as struct in body

optional string name (default: "")
optional boolean isDefault (default: false)

currenciescollection DELETE PATCH PUT POST GET /currencies

Request Body:

Loading...

Response:

get
List all currencies available

companiestypes DELETE PATCH PUT POST GET /companytypes

Request Body:

Loading...

Response:

get
Returns all possible company types

companiesturnovercollection DELETE PATCH PUT POST GET /companies/{id}/turnover

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Returns yearly turnover for a given company
required numeric id

companiestagscollection DELETE PATCH PUT POST GET /companies/{id}/tags

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Returns all tags for a given company
required numeric id

The company id

companiesranddspendingcollection DELETE PATCH PUT POST GET /companies/{id}/randdspending

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Returns yearly R&D Spending for a given company id
required numeric id

companiesheadcountscollection DELETE PATCH PUT POST GET /companies/{id}/headcounts

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Returns yearly headcounts for a given company id
required numeric id

companiesmember DELETE PATCH PUT POST GET /companies/{id}

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Returns a company by id
required numeric id

companiescollection DELETE PATCH PUT POST GET /companies

Request Body:

Loading...

Response:

get
Returns a paged resultset of companies
optional numeric offset (default: 0)
optional numeric limit (default: 10)
optional string sort (default: "")

Comma seperated list of sorting conditions in the format 'col1:asc,col2:desc'

optional numeric filterId (default: 0)

Id of a filter definition to apply to the returned companies data


Warning: Your reload key and password are using the framework default settings. It's advised that you change these in production.
Resources are listed in matching order. From top to bottom, the first URI to match the request is used.