What are the query parameters for the REST getAgreements API call?
in version 5 rest api documentation (rest api — document e-signature software — adobe sign ), there call getagreements; if sent using "try out" access token, list of documents sent under id associated access token.
there parameter documented call named "query"; explanation reads: "the query string used search. multiple search terms can provided, separated spaces. of search terms include document name, participant name or company, , form data".
where can find documentation on string used in parameter? i've tried naive things "try out" - status:expired , - , have gotten empty list back, though without parameter of documents have status of expired. i'd know possible query strings are.
a typical response agreements below json. in json text, have keys , values. specify values in query box, values, no need specify key name. example, if want agreements statuses "out_for_signature", url - "https://api.na1.echosign.com:443/api/rest/v5/agreements?query=out_for_signature". not have include key name in query.
{"displaydate":"2017-10-27t22:03:37-07:00","esign":true,"displayusersetinfos":[{"displayus ersetmemberinfos":[{"company":"adobe","email":"naveen-kumar.vanam@adobe.com"}]}],"agreementid":"3aaablblqzhaunlf0fpl0by0rk-ayxappeufoqhy9xu3kkeat2biysrcnys4gl0mbjs7g rc7plybiyepkrqwlswzbsalyitkn","name":"payment authorization","latestversionid":"3aaablblqzhap89dpwucq5hm1sp41xylaakods95hhkuivkehwdz6uo zqln9323hq-lcuw-wt8nrt68zidrwnjirdewwn4bi-","status":"out_for_signature"}
More discussions in API/3rd party integration
adobe
Comments
Post a Comment