About these Entities
Funding Program
This entity is a reference to any source of funding provided by an External Org that is tracked within the Cayuse system. This funding program data is created and maintained under organizations that act as sources of funding for Sponsored Projects. Funding programs are managed under External Organizations in the Admin app.
Funding Program Rounds
This entity is a reference to individual rounds of funding within a specific funding program. This funding program round data is created and maintained under organizations that act as sources of funding for Sponsored Projects, within an individual funding program record. Funding program rounds are managed under External Organizations in the Admin app.
The two endpoints use the new Base URLs as follows:
Funding Program
https://developer.<env>.cayuse.com/v1/external-organizations/{organizationId}/funder-programs
Funding Round
https://developer.<env>.cayuse.com/v1/funder-programs/{funderProgramId}/funding-rounds
REST Endpoints
Information about available endpoints is published in Swagger here.
Filtering Results
A GET call without search parameters returns all undeleted records. To limit the results, pass one or more search parameters using the following format (note that all search terms should be URL-encoded):
/v1/external-organizations?search={{parameter}}{{operator}}{{value}}
Example: /v1/organization/{organizationId}/funding-program?search=updateDate:>2020-11-12T12:34:56.000Z
|
Parameter |
Operator |
Values/Format |
Notes |
| updateDate |
:> :< |
yyyy-MM-ddTHH:mm:ss.SSSZ |
YYYY = four-digit year MM = two-digit month (01=January, etc.) DD = two-digit day of month (01 through 31) hh = two digits of hour (00 through 23) (am/pm NOT allowed) mm = two digits of minute (00 through 59) ss = two digits of second (00 through 59) s = one or more digits representing a decimal fraction of a second (i.e. milliseconds) Z = time zone designator Example: 2020-05-11T17:31:00.000Z |
| active | : | true or false | |
| name | : | *some*text | Accepts wildcards before, in the middle of, and after some text string |
| id | : | *some*text | Accepts wildcards before, in the middle of, and after some text string |
| organizationid | : | *some*text | Accepts wildcards before, in the middle of, and after some text string |
|
acronym |
: |
*some*text |
Accepts wildcards before, in the middle of, and after some text string |