v1 API 修改单条数据

API使用者，可以通过本接口，修改一条数据

功能	免费版	专业版/专业增强版	企业基础版	企业协作版	企业高级版
修改单条数据			✔️	✔️	✔️

认证方式

V1 Basic 认证方式

headers 设置

需要在请求中设置如下 headers

Content-Type: application/json
Accept: application/json
Authorization: 放入上一步骤生成的CODE

接口说明

个人版用户/企业子账号用户，只可以操作 自己创建 的表单数据。无法操作共享的表单。
企业全局 API，可以操作整个企业所有表单数据。

合并式修改（Merge）与覆盖式修改（Replace All）

注意，本接口支持三种 HTTP 请求（ PATCH / POST 和 PUT ）

合并式修改（Merge）

使用 PATCH 或者 POST，则本次修改数据为合并式修改（Merge）

使用这种方式，API调用者只需要传入自己期望修改的字段和值。

对于请求未传入的字段，系统会保留修改前的值。

覆盖式修改（Replace All）

使用 PUT ，则本次修改数据为覆盖式修改（Replace All）

使用这种方式，API调用者需要传入所有修改后的字段和值

对于请求未传入的字段，系统会清除修改前的值。

接口描述

Request

PATCH/POST/PUT https://jinshuju.net/api/v1/forms/FORM_TOKEN/entries/SERIAL_NUMBER

{
    "field_1": "张三",
    "field_2": "13000000000"
}

参数名称	是否必须	类型	说明
FORM_TOKEN	是	String	表单Token
SERIAL_NUMBER	是	Number	数据序号
field_*	否		对应字段的值

Response

{
    "form": "a1B2c3",
    "form_name": "产品需求调研表",
    "entry": {
        "serial_number": 28,
        "field_1": "张三",
        "field_2": "13000000000",
        "x_field_1": "",
        "creator_name": "API调用者",
        "created_at": "2020-08-28T08:00:00.000Z",
        "updated_at": "2020-08-28T08:00:00.000Z"
    }
}

参数名称	是否必须	类型	说明
form	是	String	表单Token（标识符）
form_name	是	String	表单标题
entry	是		本次请求创建成功的数据
entry.serial_number	是	Number	数据序号（标识符）
entry.field_*	是		对应字段的值
entry.creator_name	否	String	本条数据的填写者
entry.created_at	是	Date	数据提交时间
entry.updated_at	是	Date	数据最后一次变更时间

示例代码：合并式修改（Merge）

伪代码

api_key = "YOUR_API_KEY"
api_secret = "YOUR_API_SECRET"

credentials = api_key + ":" + api_secret

encoded_creadentials = base64_encode(credentials)

auth_header_payload = "Basic " + encoded_creadentials

headers = {"Authorization": auth_header_payload}

form_token = "YOUR_FORM_TOKEN"
entry_serial_number = 79

entry_json = "{\"field_1\": \"New value\"}"

http.post("https://jinshuju.net/api/v1/forms/${form_token}/entries/${entry_serial_number}", headers, entry_json)

HTTP

POST https://jinshuju.net/api/v1/forms/$FORM_TOKEN/entries/$ENTRY_SERIAL_NUMBER

Content-Type: application/json
Accept: application/json
Authorization: Basic BASE_64_ENCODED_CREDENTIALS

{"field_1": "value"}

Postman

POST https://jinshuju.net/api/v1/forms/$FORM_TOKEN/entries/$ENTRY_SERIAL_NUMBER

authorization 选择 `Basic Auth`

Username 输入 API Key
Password 输入 API Secret

Body:
{"field_1": "value"}

Java

package net.jinshuju.v1api.demo;

import java.io.*;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.Base64;

public class UpdateFormEntryWithMergeService {

    public void run(String apiKey, String apiSecret, String formToken, int entrySerialNumber) throws IOException {
        String authHeaderPayload = getAuthHeaderPayload(apiKey, apiSecret);

        BufferedReader httpResponseReader = null;
        try {
            URL apiEndpointUrl = new URL("https://jinshuju.net/api/v1/forms/" + formToken + "/entries/" + entrySerialNumber);
            HttpURLConnection urlConnection = (HttpURLConnection) apiEndpointUrl.openConnection();
            urlConnection.setRequestMethod("POST");
            urlConnection.addRequestProperty("Authorization", authHeaderPayload);
            urlConnection.setRequestProperty("Content-Type", "application/json; utf-8");
            urlConnection.setDoOutput(true);

            String entryJsonString = "{\"field_1\": \"New Value\"}";

            OutputStream os = urlConnection.getOutputStream();
            OutputStreamWriter osw = new OutputStreamWriter(os, "UTF-8");
            osw.write(entryJsonString);
            osw.flush();
            osw.close();
            os.close();
            urlConnection.connect();

            httpResponseReader = new BufferedReader(new InputStreamReader(urlConnection.getInputStream(), "UTF-8"));
            String lineRead;
            while ((lineRead = httpResponseReader.readLine()) != null) {
                System.out.println(lineRead);
            }
        } finally {
            if (httpResponseReader != null) {
                try {
                    httpResponseReader.close();
                } catch (IOException ignored) {
                }
            }
        }
    }

    private String getAuthHeaderPayload(String apiKey, String apiSecret) {
        String credentials = apiKey + ":" + apiSecret;

        String base64EncodedCredentials = Base64.getEncoder().encodeToString(credentials.getBytes());
        return "Basic " + base64EncodedCredentials;
    }
}

Python

import requests

api_key = 'YOUR_API_KEY'
api_secret = 'YOUR_API_SECRET'

form_token = 'YOUR_FORM_TOKEN'
entry_serial_number = 79
entry_json = {"field_1": "a new value"}


api_endpoint_url = 'https://jinshuju.net/api/v1/forms/' + form_token + '/entries/' + str(entry_serial_number)

response = requests.post(api_endpoint_url, auth = (api_key, api_secret), json = entry_json)

print(response.text)

Ruby

require 'net/http'
require 'uri'
require 'json'

form_token = 'YOUR_FORM_TOKEN'
entry_serial_number = 79

uri = URI.parse("https://jinshuju.net/api/v1/forms/#{form_token}/entries/#{entry_serial_number}")
api_key = 'YOUR_API_KEY'
api_secret = 'YOUR_API_SECRET'

entry_json = {field_1: 'Some New Value'}

request = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
request.basic_auth(api_key, api_secret)
request.body = entry_json.to_json

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts(response.body)

示例代码：覆盖式修改（Replace All）

伪代码

api_key = "YOUR_API_KEY"
api_secret = "YOUR_API_SECRET"

credentials = api_key + ":" + api_secret

encoded_creadentials = base64_encode(credentials)

auth_header_payload = "Basic " + encoded_creadentials

headers = {"Authorization": auth_header_payload}

form_token = "YOUR_FORM_TOKEN"
entry_serial_number = 79

entry_json = "{\"field_1\": \"New value\", \"field_2\": \"Another new value\"}"

http.put("https://jinshuju.net/api/v1/forms/${form_token}/entries/${entry_serial_number}", headers, entry_json)

HTTP

PUT https://jinshuju.net/api/v1/forms/$FORM_TOKEN/entries/$ENTRY_SERIAL_NUMBER

Authorization: Basic BASE_64_ENCODED_CREDENTIALS

{"field_1": "new value", "field_2": "another new value"}

Postman

PUT https://jinshuju.net/api/v1/forms/$FORM_TOKEN/entries/$ENTRY_SERIAL_NUMBER

authorization 选择 `Basic Auth`

Username 输入 API Key
Password 输入 API Secret

Body:
{"field_1": "new value", "field_2": "another new value"}

Java

package net.jinshuju.v1api.demo;

import java.io.*;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.Base64;

public class UpdateFormEntryWithReplaceAllService {

    public void run(String apiKey, String apiSecret, String formToken, int entrySerialNumber) throws IOException {
        String authHeaderPayload = getAuthHeaderPayload(apiKey, apiSecret);

        BufferedReader httpResponseReader = null;
        try {
            URL apiEndpointUrl = new URL("https://jinshuju.net/api/v1/forms/" + formToken + "/entries/" + entrySerialNumber);
            HttpURLConnection urlConnection = (HttpURLConnection) apiEndpointUrl.openConnection();
            urlConnection.setRequestMethod("PUT");
            urlConnection.addRequestProperty("Authorization", authHeaderPayload);
            urlConnection.setRequestProperty("Content-Type", "application/json; utf-8");
            urlConnection.setDoOutput(true);

            String entryJsonString = "{\"field_1\": \"New Value\"}";

            OutputStream os = urlConnection.getOutputStream();
            OutputStreamWriter osw = new OutputStreamWriter(os, "UTF-8");
            osw.write(entryJsonString);
            osw.flush();
            osw.close();
            os.close();
            urlConnection.connect();

            httpResponseReader = new BufferedReader(new InputStreamReader(urlConnection.getInputStream(), "UTF-8"));
            String lineRead;
            while ((lineRead = httpResponseReader.readLine()) != null) {
                System.out.println(lineRead);
            }
        } finally {
            if (httpResponseReader != null) {
                try {
                    httpResponseReader.close();
                } catch (IOException ignored) {
                }
            }
        }
    }

    private String getAuthHeaderPayload(String apiKey, String apiSecret) {
        String credentials = apiKey + ":" + apiSecret;

        String base64EncodedCredentials = Base64.getEncoder().encodeToString(credentials.getBytes());
        return "Basic " + base64EncodedCredentials;
    }
}

Python

import requests

api_key = 'YOUR_API_KEY'
api_secret = 'YOUR_API_SECRET'

form_token = 'YOUR_FORM_TOKEN'
entry_serial_number = 79
entry_json = {"field_1": "a new value"}


api_endpoint_url = 'https://jinshuju.net/api/v1/forms/' + form_token + '/entries/' + str(entry_serial_number)

response = requests.put(api_endpoint_url, auth = (api_key, api_secret), json = entry_json)

print(response.text)

Ruby

require 'net/http'
require 'uri'
require 'json'

form_token = 'YOUR_FORM_TOKEN'
entry_serial_number = 79

uri = URI.parse("https://jinshuju.net/api/v1/forms/#{form_token}/entries/#{entry_serial_number}")
api_key = 'YOUR_API_KEY'
api_secret = 'YOUR_API_SECRET'

entry_json = {field_1: 'Some New Value'}

request = Net::HTTP::Put.new(uri, 'Content-Type' => 'application/json')
request.basic_auth(api_key, api_secret)
request.body = entry_json.to_json

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts(response.body)

认证方式​

headers 设置​

接口说明​

合并式修改（Merge）与 覆盖式修改（Replace All）​

合并式修改（Merge）​

覆盖式修改（Replace All）​

接口描述​

Request​

Response​

示例代码：合并式修改（Merge）​

伪代码​

HTTP​

Postman​

Java​

Python​

Ruby​

示例代码：覆盖式修改（Replace All）​

伪代码​

HTTP​

Postman​

Java​

Python​

Ruby​

认证方式

headers 设置

接口说明

合并式修改（Merge）与覆盖式修改（Replace All）

合并式修改（Merge）

覆盖式修改（Replace All）

接口描述

Request

Response

示例代码：合并式修改（Merge）

伪代码

HTTP

Postman

Java

Python

Ruby

示例代码：覆盖式修改（Replace All）

伪代码

HTTP

Postman

Java

Python

Ruby