My City Construction Web Api (v1)

Download OpenAPI specification:Download

My City ConstructionのWebAPIです。

products

工事・業務データ関連API

工事/業務データを作成する

工事/業務データを作成する

Request Body schema: application/json

工事/業務データ

kind
required
string

種別 SURVEY_DESIGN:調査設計 GEOLOGICAL_SURVEY:地質調査 SURVEYING:測量 OTHER_WORK:その他業務 CONSTRUCTION:工事

name
required
string

業務/工事名称

client_name
required
string

発注機関名

contractor_name
required
string

受注機関名

start_date
required
string

工期開始日

end_date
required
string

工期終了日

required
Array of objects (Address)

住所リスト

Array of objects (PointLocation)

場所情報(点)リスト
場所情報は点・線・面いずれか1つ以上のデータが必須

Array of objects (LineLocation)

場所情報(線)リスト
場所情報は点・線・面いずれか1つ以上のデータが必須

Array of objects (AreaLocation)

場所情報(面)リスト
場所情報は点・線・面いずれか1つ以上のデータが必須

overview
required
string

概要

client_corporate_number
required
string

発注者法人番号

required
Array of objects (ClientPerson)

発注担当者リスト

required
Array of objects (ContractorPerson)

受注担当者リスト

amount
integer

金額(税込)

corins_tecris_number
string

コリンズテクリス番号

design_document_code
string

設計書コード

keyword
string

キーワード

object (ClientOrganization)

発注機関
電子納品に関する要領・基準 発注者コードを参照
codeとname両方が指定された場合、codeが優先される
http://www.cals-ed.go.jp/h2803_code/

object (ConstructionIndustry)

工事業種
電子納品に関する要領・基準 工事業種コードを参照
codeとname両方が指定された場合、codeが優先される
http://www.cals-ed.go.jp/h2803_code/

object (ConstructionField)

工事分野コード
電子納品に関する要領・基準 工事分野コードを参照
codeとname両方が指定された場合、codeが優先される
http://www.cals-ed.go.jp/h2803_code/

Array of objects (ConstructionKindAndMethod)

工種・工法型式リスト

object (DesignField)

業務分野コード
電子納品に関する要領・基準 業務分野コードを参照
codeとname両方が指定された場合、codeが優先される
http://www.cals-ed.go.jp/h2803_code/

client_organization_code
string
Deprecated

発注者コード
コードは電子納品に関する要領・基準 発注者コードを参照
http://www.cals-ed.go.jp/h2803_code/

construction_industry_code
string
Deprecated

工事業種コード
コードは電子納品に関する要領・基準 工事業種コードを参照
http://www.cals-ed.go.jp/h2803_code/

construction_field_code
string
Deprecated

工事分野コード
コードは電子納品に関する要領・基準 工事分野コードを参照
http://www.cals-ed.go.jp/h2803_code/

Array of objects (ConstructionKindAndMethodCode)
Deprecated

工種・工法型式コードリスト

design_field_code
string
Deprecated

業務分野コード
コードは電子納品に関する要領・基準 業務分野コードを参照
http://www.cals-ed.go.jp/h2803_code/

Responses

Request samples

Content type
application/json
{
  • "kind": "CONSTRUCTION",
  • "name": "国道○号○○舗装修繕工事",
  • "client_name": "国土交通省○○地方整備局○○事務所",
  • "contractor_name": "○○建設株式会社△△組共同企業体(代表:○○建設株式会社)",
  • "start_date": "2017-11-01",
  • "end_date": "2019-03-26",
  • "addresses": [
    ],
  • "point_locations": [
    ],
  • "line_locations": [
    ],
  • "area_locations": [
    ],
  • "overview": "掘削工8500m3、土留め工2800m2、埋戻し工9500m3、路面覆工300m2",
  • "client_corporate_number": "0000000102004",
  • "client_persons": [
    ],
  • "contractor_persons": [
    ],
  • "amount": 10000000,
  • "corins_tecris_number": "12345678K",
  • "design_document_code": "207011110123",
  • "keyword": "サンプル キーワード",
  • "client_organization": {
    },
  • "construction_industry": {
    },
  • "construction_field": {
    },
  • "construction_kind_and_methods": [
    ],
  • "design_field": {
    },
  • "client_organization_code": "00101001",
  • "construction_industry_code": "01",
  • "construction_field_code": "02",
  • "construction_kind_and_method_codes": [
    ],
  • "design_field_code": "0111000"
}

Response samples

Content type
application/json
{
  • "product": {
    }
}

公開されている工事・業務データ一覧を検索する

公開されている工事・業務データ一覧を検索する

query Parameters
q
string

文字列検索

文字列で検索を行う。文字列は一部を除き部分一致検索される。
パラメータを半角/全角スペースで区切るとOR検索が行われる。
完全一致検索が行われるのは以下のデータ
  • 発注機関名法人番号
  • 受注機関名法人番号
  • 設計書コード
  • コリンズ・テクリス番号
items
string

成果物の絞り込み検索

成果物の有無で絞り込み検索を行う
以下の文字列を指定して絞り込みができる
指定された文字列以外の場合、この絞り込み検索は無視される。
  • PUBLISHED(成果物を公開している工事データ)
  • UNPUBLISHED(成果物を公開していない工事データ)
kind
string

「種別(kind)」の絞り込み検索

「種別(kind)」で絞り込み検索を行う。文字列は完全一致検索される。
パラメータを半角/全角スペースで区切るとOR検索が行われる。 種別絞り込み検索で利用できる文字列は以下の通り。
  • SURVEY_DESIGN(調査設計)
  • GEOLOGICAL_SURVEY(地質調査)
  • SURVEYING(測量)
  • OTHER_WORK(その他業務)
  • CONSTRUCTION(工事)
corins_tecris_number
string

「コリンズ・テクリス番号(corins_tecris_number)」の絞り込み検索

「コリンズ・テクリス番号(corins_tecris_number)」で絞り込み検索を行う。文字列は完全一致検索される。
パラメータを半角/全角スペースで区切るとOR検索が行われる。
design_document_code
string

「設計書コード(design_document_code)」の絞り込み検索

「設計書コード(design_document_code)」で絞り込み検索を行う。文字列は完全一致検索される。
パラメータを半角/全角スペースで区切るとOR検索が行われる。
client_corporate_number
string

「発注機関名法人番号(client_corporate_number)」の絞り込み検索

「発注機関名法人番号(client_corporate_number)」で絞り込み検索を行う。文字列は完全一致検索される。
パラメータを半角/全角スペースで区切るとOR検索が行われる。
contractor_corporate_number
string

「受注機関名法人番号(contractor_corporate_number)」の絞り込み検索

「発注機関名法人番号(contractor_corporate_number)」で絞り込み検索を行う。文字列は完全一致検索される。
パラメータを半角/全角スペースで区切るとOR検索が行われる。
from
string

工期範囲検索(始まり)

工期開始日、工期終了日について期間で検索できる。
form以降に含まれる工事が検索される。toと組み合わせることで、ある期間の工事を検索することができる。
to
string

工期範囲検索(終わり)

工期開始日、工期終了日について期間で検索できる。
to以前に含まれる工事が検索される。fromと組み合わせることで、ある期間の工事を検索することができる。
fields
string

表示フィールドの設定

取得するフィールドを限定する事ができる。
パラメータを半角/全角スペースで区切ることにより、取得するフィールド名を複数指定することができる。
ただし、「id」フィールドは設定に関わらず必ず取得される。
不要なフィールドがある場合はfieldsパラメータを設定することにより、取得するデータ量を削減することができる。
page
integer

ページ設定

工事データ一覧は一度のリクエストにつき決められた件数(デフォルトでは20件)のみしか取得できない。
pageを設定することによりページングされた一覧を取得することができる。
次のpage,前のpageが存在するかどうかは
工事データ一覧レスポンス中のpagination.hasPrev, pagenation.hasNext
最大のページ数は工事データ一覧レスポンス中のpagination.maxPageCountを参照。
limit
integer

最大取得件数設定

1度のリクエストでの最大取得件数を設定する。
デフォルトでは20件。
limitを設定することにより、最小1件、最大100件のデータを1度のリクエストで取得できる。
sort
string

一覧ソート設定

一覧ソートを設定する。デフォルトではid順になっている。directionを指定しない場合、昇順でソートされる。
指定できるフィールド名は以下の通り。
  • id
  • 工事名(name)
  • 種別(kind)
  • 工期開始日(start_date)
  • 工期終了日(end_date)
  • 発注者名(client_name)
  • 受注者名(contractor_name)
  • 発注機関名法人番号(client_corporate_number)
  • 受注機関名法人番号(contractor_corporate_number)
  • 金額(amount)
direction
string

昇順/降順設定

ソートの昇順/降順を設定する。
昇順(asc)または降順(desc)を指定する。

Responses

Response samples

Content type
application/json
{
  • "contents": [
    ],
  • "pagination": {
    }
}

工事/業務データを取得する

工事/業務データを取得する

path Parameters
product_id
required
integer

工事/業務データID

Responses

Response samples

Content type
application/json
{
  • "product": {
    }
}

工事/業務データを更新する Deprecated

(廃止理由)PUTメソッドはリソースの完全な置換を表すメソッドである
本APIにおける工事/業務データの更新は部分置換であり、メソッドのセマンティクスに合致しないため廃止する
本APIの代替としてPATCHメソッドを利用すること

path Parameters
product_id
required
integer

工事/業務データID

Request Body schema: application/json
kind
string

種別 SURVEY_DESIGN:調査設計 GEOLOGICAL_SURVEY:地質調査 SURVEYING:測量 OTHER_WORK:その他業務 CONSTRUCTION:工事

name
string

業務/工事名称

client_name
string

発注機関名

contractor_name
string

受注機関名

start_date
string

工期開始日

end_date
string

工期終了日

Array of objects (Address)

住所リスト

Array of objects (PointLocation)

場所情報(点)リスト
場所情報は点・線・面いずれか1つ以上のデータが必須

Array of objects (LineLocation)

場所情報(線)リスト
場所情報は点・線・面いずれか1つ以上のデータが必須

Array of objects (AreaLocation)

場所情報(面)リスト
場所情報は点・線・面いずれか1つ以上のデータが必須

overview
string

概要

client_corporate_number
string

発注者法人番号

Array of objects (ClientPerson)

発注担当者リスト

Array of objects (ContractorPerson)

受注担当者リスト

amount
integer

金額(税込)

corins_tecris_number
string

コリンズテクリス番号

design_document_code
string

設計書コード

keyword
string

キーワード

object (ClientOrganization)

発注機関
電子納品に関する要領・基準 発注者コードを参照
codeとname両方が指定された場合、codeが優先される
http://www.cals-ed.go.jp/h2803_code/

object (ConstructionIndustry)

工事業種
電子納品に関する要領・基準 工事業種コードを参照
codeとname両方が指定された場合、codeが優先される
http://www.cals-ed.go.jp/h2803_code/

object (ConstructionField)

工事分野コード
電子納品に関する要領・基準 工事分野コードを参照
codeとname両方が指定された場合、codeが優先される
http://www.cals-ed.go.jp/h2803_code/

Array of objects (ConstructionKindAndMethod)

工種・工法型式リスト

object (DesignField)

業務分野コード
電子納品に関する要領・基準 業務分野コードを参照
codeとname両方が指定された場合、codeが優先される
http://www.cals-ed.go.jp/h2803_code/

client_organization_code
string
Deprecated

発注者コード
コードは電子納品に関する要領・基準 発注者コードを参照
http://www.cals-ed.go.jp/h2803_code/

construction_industry_code
string
Deprecated

工事業種コード
コードは電子納品に関する要領・基準 工事業種コードを参照
http://www.cals-ed.go.jp/h2803_code/

construction_field_code
string
Deprecated

工事分野コード
コードは電子納品に関する要領・基準 工事分野コードを参照
http://www.cals-ed.go.jp/h2803_code/

Array of objects (ConstructionKindAndMethodCode)
Deprecated

工種・工法型式コードリスト

design_field_code
string
Deprecated

業務分野コード
コードは電子納品に関する要領・基準 業務分野コードを参照
http://www.cals-ed.go.jp/h2803_code/

Responses

Request samples

Content type
application/json
{
  • "kind": "CONSTRUCTION",
  • "name": "国道○号○○舗装修繕工事",
  • "client_name": "国土交通省○○地方整備局○○事務所",
  • "contractor_name": "○○建設株式会社△△組共同企業体(代表:○○建設株式会社)",
  • "start_date": "2017-11-01",
  • "end_date": "2019-03-26",
  • "addresses": [
    ],
  • "point_locations": [
    ],
  • "line_locations": [
    ],
  • "area_locations": [
    ],
  • "overview": "掘削工8500m3、土留め工2800m2、埋戻し工9500m3、路面覆工300m2",
  • "client_corporate_number": "0000000102004",
  • "client_persons": [
    ],
  • "contractor_persons": [
    ],
  • "amount": 10000000,
  • "corins_tecris_number": "12345678K",
  • "design_document_code": "207011110123",
  • "keyword": "サンプル キーワード",
  • "client_organization": {
    },
  • "construction_industry": {
    },
  • "construction_field": {
    },
  • "construction_kind_and_methods": [
    ],
  • "design_field": {
    },
  • "client_organization_code": "00101001",
  • "construction_industry_code": "01",
  • "construction_field_code": "02",
  • "construction_kind_and_method_codes": [
    ],
  • "design_field_code": "0111000"
}

Response samples

Content type
application/json
{
  • "product": {
    }
}

工事/業務データを更新する

工事/業務データを更新する

path Parameters
product_id
required
integer

工事/業務データID

Request Body schema: application/json
kind
string

種別 SURVEY_DESIGN:調査設計 GEOLOGICAL_SURVEY:地質調査 SURVEYING:測量 OTHER_WORK:その他業務 CONSTRUCTION:工事

name
string

業務/工事名称

client_name
string

発注機関名

contractor_name
string

受注機関名

start_date
string

工期開始日

end_date
string

工期終了日

Array of objects (Address)

住所リスト

Array of objects (PointLocation)

場所情報(点)リスト
場所情報は点・線・面いずれか1つ以上のデータが必須

Array of objects (LineLocation)

場所情報(線)リスト
場所情報は点・線・面いずれか1つ以上のデータが必須

Array of objects (AreaLocation)

場所情報(面)リスト
場所情報は点・線・面いずれか1つ以上のデータが必須

overview
string

概要

client_corporate_number
string

発注者法人番号

Array of objects (ClientPerson)

発注担当者リスト

Array of objects (ContractorPerson)

受注担当者リスト

amount
integer

金額(税込)

corins_tecris_number
string

コリンズテクリス番号

design_document_code
string

設計書コード

keyword
string

キーワード

object (ClientOrganization)

発注機関
電子納品に関する要領・基準 発注者コードを参照
codeとname両方が指定された場合、codeが優先される
http://www.cals-ed.go.jp/h2803_code/

object (ConstructionIndustry)

工事業種
電子納品に関する要領・基準 工事業種コードを参照
codeとname両方が指定された場合、codeが優先される
http://www.cals-ed.go.jp/h2803_code/

object (ConstructionField)

工事分野コード
電子納品に関する要領・基準 工事分野コードを参照
codeとname両方が指定された場合、codeが優先される
http://www.cals-ed.go.jp/h2803_code/

Array of objects (ConstructionKindAndMethod)

工種・工法型式リスト

object (DesignField)

業務分野コード
電子納品に関する要領・基準 業務分野コードを参照
codeとname両方が指定された場合、codeが優先される
http://www.cals-ed.go.jp/h2803_code/

client_organization_code
string
Deprecated

発注者コード
コードは電子納品に関する要領・基準 発注者コードを参照
http://www.cals-ed.go.jp/h2803_code/

construction_industry_code
string
Deprecated

工事業種コード
コードは電子納品に関する要領・基準 工事業種コードを参照
http://www.cals-ed.go.jp/h2803_code/

construction_field_code
string
Deprecated

工事分野コード
コードは電子納品に関する要領・基準 工事分野コードを参照
http://www.cals-ed.go.jp/h2803_code/

Array of objects (ConstructionKindAndMethodCode)
Deprecated

工種・工法型式コードリスト

design_field_code
string
Deprecated

業務分野コード
コードは電子納品に関する要領・基準 業務分野コードを参照
http://www.cals-ed.go.jp/h2803_code/

Responses

Request samples

Content type
application/json
{
  • "kind": "CONSTRUCTION",
  • "name": "国道○号○○舗装修繕工事",
  • "client_name": "国土交通省○○地方整備局○○事務所",
  • "contractor_name": "○○建設株式会社△△組共同企業体(代表:○○建設株式会社)",
  • "start_date": "2017-11-01",
  • "end_date": "2019-03-26",
  • "addresses": [
    ],
  • "point_locations": [
    ],
  • "line_locations": [
    ],
  • "area_locations": [
    ],
  • "overview": "掘削工8500m3、土留め工2800m2、埋戻し工9500m3、路面覆工300m2",
  • "client_corporate_number": "0000000102004",
  • "client_persons": [
    ],
  • "contractor_persons": [
    ],
  • "amount": 10000000,
  • "corins_tecris_number": "12345678K",
  • "design_document_code": "207011110123",
  • "keyword": "サンプル キーワード",
  • "client_organization": {
    },
  • "construction_industry": {
    },
  • "construction_field": {
    },
  • "construction_kind_and_methods": [
    ],
  • "design_field": {
    },
  • "client_organization_code": "00101001",
  • "construction_industry_code": "01",
  • "construction_field_code": "02",
  • "construction_kind_and_method_codes": [
    ],
  • "design_field_code": "0111000"
}

Response samples

Content type
application/json
{
  • "product": {
    }
}

工事/業務データを削除する

工事/業務データを削除する

path Parameters
product_id
required
integer

工事/業務データID

Responses

Response samples

Content type
application/json
{
  • "status": "success"
}

工事写真を取得する

工事写真を取得する

path Parameters
product_id
required
integer

工事/業務データID

query Parameters
thumb
string

サムネイルを取得

Responses

工事写真を保存する

工事写真を保存する。2MB以下のJPEG、PNG、GIFファイルをアップロードできる。

path Parameters
product_id
required
integer

工事/業務データID

Request Body schema: multipart/form-data
photo
required
string <binary>

ファイルデータ

Responses

Response samples

Content type
application/json
{
  • "status": "success"
}

工事写真を削除する

工事写真を削除する

path Parameters
product_id
required
integer

工事/業務データID

Responses

Response samples

Content type
application/json
{
  • "status": "success"
}

工事データを申請する

工事データを申請する
申請完了後、発注担当者に申請が行われた旨のメールが送信される

path Parameters
product_id
required
integer

工事/業務データID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "mail_send_fails": [
    ]
}

工事データを承認する

工事データを承認する
承認完了後、発注担当者、受注担当者に承認が行われた旨のメールが送信される

path Parameters
product_id
required
integer

工事/業務データID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "mail_send_fails": [
    ]
}

工事データを差し戻しする

工事データを差し戻しする
差し戻し完了後、差し戻したユーザが

  • 受注者の場合、発注担当者
  • 発注者の場合、受注担当者
に差し戻しが行われた旨のメールが送信される

path Parameters
product_id
required
integer

工事/業務データID

Request Body schema: application/json
comment
required
string

差し戻し理由

Responses

Request samples

Content type
application/json
{
  • "comment": "データ不備により、差し戻します。"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "mail_send_fails": [
    ]
}

uploads

成果物のアップロードに関するAPI

ファイル簡易アップロードを行う

ファイル簡易アップロードを行う。100MB以下のファイルをアップロードできる
100MB以上のファイルをアップロードしたい場合は、分割アップロードを行うこと

path Parameters
product_id
required
integer

工事/業務データID

folder_path
required
string

アップロードするファイルを配置するフォルダパス 例) test/file

Request Body schema: multipart/form-data
file
required
string <binary>

ファイルデータ

Responses

Response samples

Content type
application/json
{
  • "status": "success"
}

アップロード開始URLを要求する

アップロード開始URLを要求する

path Parameters
product_id
required
integer

工事/業務データID

file_path
required
string

アップロードするファイルを配置するファイル名を含むパス 例) test/file/sample.png

Responses

分割アップロードURLを要求する

分割アップロードURLを要求する

path Parameters
product_id
required
integer

工事/業務データID

file_path
required
string

アップロードするファイルを配置するファイル名を含むパス 例) test/file/sample.png

query Parameters
part_number
required
integer

分割番号

upload_id
required
string

AWSから提供されたアップロードID

Responses

アップロード結合URLを要求する

アップロード結合URLを要求する

path Parameters
product_id
required
integer

工事/業務データID

file_path
required
string

アップロードするファイルを配置するファイル名を含むパス 例) test/file/sample.png

query Parameters
upload_id
required
string

AWSから提供されたアップロードID

Responses

アップロード中止URLを要求する

アップロード中止URLを要求する

path Parameters
product_id
required
integer

工事/業務データID

file_path
required
string

アップロードするファイルを配置するファイル名を含むパス 例) test/file/sample.png

query Parameters
upload_id
required
string

AWSから提供されたアップロードID

Responses

アップロードデータを登録する

アップロードデータを登録する
このリクエストはアップロードの結合が完了し、ファイルがアップロードされた後に行う

path Parameters
product_id
required
integer

工事/業務データID

file_path
required
string

アップロードするファイルを配置するファイル名を含むパス 例) test/file/sample.png

Responses

Response samples

Content type
application/json
{
  • "status": "success"
}

files

成果物ファイルに関するAPI

成果物ファイルを取得する

成果物ファイルを取得する。

path Parameters
product_id
required
integer

工事/業務データID

file_path
required
string

成果物のファイルパス 例) test/file/sample.png

query Parameters
metadata
string

成果物ファイルのメタデータを取得する。 このクエリパラメータは、成果物ファイルの存在確認等に有効。

inline
string

ContentDispositionを付与しない成果物ファイルを取得する。 このクエリパラメータは、metadataクエリパラメータが設定されている場合は無視される。

json
string

バイナリではなく、成果物ファイル取得先のURLをJSON形式で取得する。 成果物ファイル取得先のURLは非常に短い有効期限(15秒)を持つ。 このクエリパラメータは、metadataクエリパラメータが設定されている場合は無視される。

Responses

Response samples

Content type
バイナリデータ

成果物ファイルの公開・非公開を変更する

成果物ファイルの公開・非公開を変更する

path Parameters
product_id
required
integer

工事/業務データID

file_path
required
string

成果物のファイルパス 例) test/file/sample.png

Request Body schema: application/json
state
required
string

公開・非公開状態 PUBLISH:公開 UNPUBLISH:非公開

Responses

Request samples

Content type
application/json
{
  • "state": "PUBLISH"
}

Response samples

Content type
application/json
{
  • "name": "INDE_C.xml",
  • "folder_path": "/ICON",
  • "state": "PUBLISH",
  • "size": 100,
  • "create_date": "2020-05-01",
  • "update_date": "2020-06-01"
}

成果物ファイルを削除する

成果物ファイルを削除する

path Parameters
product_id
required
integer

工事/業務データID

file_path
required
string

成果物のファイルパス 例) test/file/sample.png

Responses

Response samples

Content type
application/json
{
  • "status": "success"
}

folders

成果物フォルダに関するAPI

成果物フォルダ内成果物一覧を取得する

成果物フォルダ内成果物一覧を取得する

path Parameters
product_id
required
integer

工事/業務データID

file_path
required
string

成果物フォルダパス 例) test/folder

query Parameters
recursive
string

ファイルを再帰的に取得

フォルダ内のファイルを再帰的に取得する
extension
string

「ファイル拡張子」の絞り込み検索

「ファイル拡張子」で絞り込み検索を行う。文字列は完全一致検索される。
拡張子の大文字小文字は区別しない。
パラメータを半角/全角スペースで区切るとOR検索が行われる。
page
integer

ページ設定

フォルダ内成果物一覧は一度のリクエストにつき決められた件数(デフォルトでは20件)のみしか取得できない。
pageを設定することによりページングされた一覧を取得することができる。
次のpage,前のpageが存在するかどうかは
工事データ一覧レスポンス中のpagination.hasPrev, pagenation.hasNext
最大のページ数はフォルダ内成果物一覧レスポンス中のpagination.maxPageCountを参照。
limit
integer

最大取得件数設定

1度のリクエストでの最大取得件数を設定する。
デフォルトでは20件。
limitを設定することにより、最小1件、最大100件のデータを1度のリクエストで取得できる。
sort
string

一覧ソート設定

一覧ソートを設定する。デフォルトでは名称順になっている。directionを指定しない場合、昇順でソートされる。
指定できるフィールド名は以下の通り。
  • 名称(name)
  • サイズ(size)
  • 作成日時(create_date)
  • 更新日時(update_date)
  • 公開状態(state)
  • フォルダかどうか(is_folder)
direction
string

昇順/降順設定

ソートの昇順/降順を設定する。
昇順(asc)または降順(desc)を指定する。

Responses

Response samples

Content type
application/json
{
  • "contents": [
    ],
  • "pagination": {
    }
}

空の成果物フォルダを作成する

空の成果物フォルダを作成する
成果物フォルダは非公開の状態で作成される

path Parameters
product_id
required
integer

工事/業務データID

file_path
required
string

成果物フォルダパス 例) test/folder

Request Body schema: application/json
foler_name
string

フォルダ名

Responses

Request samples

Content type
application/json
{
  • "foler_name": "empty_folder"
}

Response samples

Content type
application/json
{
  • "name": "ICON",
  • "folder_path": "/",
  • "state": "PUBLISH",
  • "size": 100,
  • "is_folder": true,
  • "create_date": "2020-05-01",
  • "update_date": "2020-06-01"
}

成果物フォルダの公開・非公開を変更する

成果物フォルダの公開・非公開を変更する
成果物フォルダ内にあるすべてのフォルダ・ファイルは再帰的に公開設定が変更される

path Parameters
product_id
required
integer

工事/業務データID

file_path
required
string

成果物フォルダパス 例) test/folder

Request Body schema: application/json
state
required
string

公開・非公開状態 PUBLISH:公開 UNPUBLISH:非公開

Responses

Request samples

Content type
application/json
{
  • "state": "PUBLISH"
}

Response samples

Content type
application/json
{
  • "name": "INDE_C.xml",
  • "folder_path": "/ICON",
  • "state": "PUBLISH",
  • "size": 100,
  • "is_folder": false,
  • "create_date": "2020-05-01",
  • "update_date": "2020-06-01"
}

成果物フォルダを削除する

成果物フォルダを削除する
成果物フォルダ内にあるすべてのフォルダ・ファイルは再帰的に削除される

path Parameters
product_id
required
integer

工事/業務データID

file_path
required
string

成果物フォルダパス 例) test/folder

Responses

Response samples

Content type
application/json
{
  • "status": "success"
}

items

成果物フォルダ・ファイルに関するAPI

フォルダをZIP形式でダウンロードする

フォルダをZIP形式でダウンロードする
フォルダ内のフォルダ・ファイルは再帰的にダウンロードされる

path Parameters
product_id
required
integer

工事/業務データID

folder_path
required
string

ダウンロードするフォルダパス 例) test/folder

query Parameters
json
string

バイナリではなく、ZIP形式のフォルダ取得先のURLをJSON形式で取得する。 ZIP形式のフォルダ取得先のURLは非常に短い有効期限(15秒)を持つ。

Responses

Response samples

Content type
バイナリデータ

フォルダ内のファイル・フォルダを選択して削除する

フォルダ内のファイル・フォルダを選択して削除する
フォルダ内のフォルダ・ファイルは再帰的に削除される

path Parameters
product_id
required
integer

工事/業務データID

folder_path
required
string

対象フォルダパス 例) test/folder

Request Body schema: application/json

選択したパス配列

selects
required
Array of arrays

削除するファイル・フォルダパスの配列
対象フォルダパスの相対パスを指定する
また、フォルダを削除する場合は末尾に / を付与する

Responses

Request samples

Content type
application/json
{
  • "selects": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success"
}

users

ユーザに関するAPI

工事・業務データ一覧を検索する

APIを利用しているユーザが関連している工事・業務データ一覧を検索する

query Parameters
q
string

文字列検索

文字列で検索を行う。文字列は一部を除き部分一致検索される。
パラメータを半角/全角スペースで区切るとOR検索が行われる。
完全一致検索が行われるのは以下のデータ
  • 発注機関名法人番号
  • 受注機関名法人番号
  • 設計書コード
  • コリンズ・テクリス番号
items
string

成果物の絞り込み検索

成果物の有無で絞り込み検索を行う
以下の文字列を指定して絞り込みができる
指定された文字列以外の場合、この絞り込み検索は無視される。
  • PUBLISHED(成果物を公開している工事データ)
  • UNPUBLISHED(成果物を公開していない工事データ)
kind
string

「種別(kind)」の絞り込み検索

「種別(kind)」で絞り込み検索を行う。文字列は完全一致検索される。
パラメータを半角/全角スペースで区切るとOR検索が行われる。 種別絞り込み検索で利用できる文字列は以下の通り。
  • SURVEY_DESIGN(調査設計)
  • GEOLOGICAL_SURVEY(地質調査)
  • SURVEYING(測量)
  • OTHER_WORK(その他業務)
  • CONSTRUCTION(工事)
status
string

「状態(status)」の絞り込み検索

「状態(status)」で絞り込み検索を行う。文字列は完全一致検索される。
パラメータを半角/全角スペースで区切るとOR検索が行われる。 状態絞り込み検索で利用できる文字列は以下の通り。
  • UNAPPROVED(未承認)
  • APPLIED(申請中)
  • APPROVED(承認済)
corins_tecris_number
string

「コリンズ・テクリス番号(corins_tecris_number)」の絞り込み検索

「コリンズ・テクリス番号(corins_tecris_number)」で絞り込み検索を行う。文字列は完全一致検索される。
パラメータを半角/全角スペースで区切るとOR検索が行われる。
design_document_code
string

「設計書コード(design_document_code)」の絞り込み検索

「設計書コード(design_document_code)」で絞り込み検索を行う。文字列は完全一致検索される。
パラメータを半角/全角スペースで区切るとOR検索が行われる。
client_corporate_number
string

「発注機関名法人番号(client_corporate_number)」の絞り込み検索

「発注機関名法人番号(client_corporate_number)」で絞り込み検索を行う。文字列は完全一致検索される。
パラメータを半角/全角スペースで区切るとOR検索が行われる。
contractor_corporate_number
string

「受注機関名法人番号(contractor_corporate_number)」の絞り込み検索

「発注機関名法人番号(contractor_corporate_number)」で絞り込み検索を行う。文字列は完全一致検索される。
パラメータを半角/全角スペースで区切るとOR検索が行われる。
from
string

工期範囲検索(始まり)

工期開始日、工期終了日について期間で検索できる。
form以降に含まれる工事が検索される。toと組み合わせることで、ある期間の工事を検索することができる。
to
string

工期範囲検索(終わり)

工期開始日、工期終了日について期間で検索できる。
to以前に含まれる工事が検索される。fromと組み合わせることで、ある期間の工事を検索することができる。
fields
string

表示フィールドの設定

取得するフィールドを限定する事ができる。
パラメータを半角/全角スペースで区切ることにより、取得するフィールド名を複数指定することができる。
ただし、「id」フィールドは設定に関わらず必ず取得される。
不要なフィールドがある場合はfieldsパラメータを設定することにより、取得するデータ量を削減することができる。
page
integer

ページ設定

工事データ一覧は一度のリクエストにつき決められた件数(デフォルトでは20件)のみしか取得できない。
pageを設定することによりページングされた一覧を取得することができる。
次のpage,前のpageが存在するかどうかは
工事データ一覧レスポンス中のpagination.hasPrev, pagenation.hasNext
最大のページ数は工事データ一覧レスポンス中のpagination.maxPageCountを参照。
limit
integer

最大取得件数設定

1度のリクエストでの最大取得件数を設定する。
デフォルトでは20件。
limitを設定することにより、最小1件、最大100件のデータを1度のリクエストで取得できる。
sort
string

一覧ソート設定

一覧ソートを設定する。デフォルトではid順になっている。directionを指定しない場合、昇順でソートされる。
指定できるフィールド名は以下の通り。
  • id
  • 工事名(name)
  • 種別(kind)
  • 状態(status)
  • 工期開始日(start_date)
  • 工期終了日(end_date)
  • 発注者名(client_name)
  • 受注者名(contractor_name)
  • 発注機関名法人番号(client_corporate_number)
  • 受注機関名法人番号(contractor_corporate_number)
  • 金額(amount)
direction
string

昇順/降順設定

ソートの昇順/降順を設定する。
昇順(asc)または降順(desc)を指定する。

Responses

Response samples

Content type
application/json
{
  • "contents": [
    ],
  • "pagination": {
    }
}