Download OpenAPI specification:Download
My City ConstructionのWebAPIです。
工事/業務データを作成する
工事/業務データ
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) 場所情報(点)リスト | |
Array of objects (LineLocation) 場所情報(線)リスト | |
Array of objects (AreaLocation) 場所情報(面)リスト | |
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) 発注機関 | |
object (ConstructionIndustry) 工事業種 | |
object (ConstructionField) 工事分野コード | |
Array of objects (ConstructionKindAndMethod) 工種・工法型式リスト | |
object (DesignField) 業務分野コード | |
client_organization_code | |
construction_industry_code | |
construction_field_code | |
Array of objects (ConstructionKindAndMethodCode) Deprecated 工種・工法型式コードリスト | |
design_field_code |
{- "kind": "CONSTRUCTION",
- "name": "国道○号○○舗装修繕工事",
- "client_name": "国土交通省○○地方整備局○○事務所",
- "contractor_name": "○○建設株式会社△△組共同企業体(代表:○○建設株式会社)",
- "start_date": "2017-11-01",
- "end_date": "2019-03-26",
- "addresses": [
- {
- "address_names": [
- {
- "name": "サンプル市町村"
}
], - "prefecture_and_cities": [
- {
- "code": "01101",
- "name": {
- "prefecture": "北海道",
- "city": "札幌市"
}
}
], - "address_codes": [
- {
- "code": "01102"
}
]
}
], - "point_locations": [
- {
- "lat": 33.034,
- "lng": 123.034
}
], - "line_locations": [
- {
- "start_lat": 33.035,
- "start_lng": 123.034,
- "end_lat": 34.035,
- "end_lng": 124.034
}
], - "area_locations": [
- {
- "northern_lat": 33.035,
- "eastern_lng": 123.034,
- "southern_lat": 34.035,
- "western_lng": 124.034
}
], - "overview": "掘削工8500m3、土留め工2800m2、埋戻し工9500m3、路面覆工300m2",
- "client_corporate_number": "0000000102004",
- "client_persons": [
- {
- "department": "○○部署",
- "name": "山田 太郎",
- "email": "t-yamada@example.com"
}
], - "contractor_persons": [
- {
- "department": "△△部署",
- "name": "田中 次郎",
- "email": "j-tanaka@example.com"
}
], - "amount": 10000000,
- "corins_tecris_number": "12345678K",
- "design_document_code": "207011110123",
- "keyword": "サンプル キーワード",
- "client_organization": {
- "code": "00101001",
- "name": {
- "first_level": "国の機関",
- "second_level": "内閣府",
- "third_level": "(内部部局)",
- "fourth_level": "(大臣官房)"
}
}, - "construction_industry": {
- "code": "01",
- "name": "土木一式工事"
}, - "construction_field": {
- "code": "01",
- "name": "河川"
}, - "construction_kind_and_methods": [
- {
- "code": "290",
- "name": {
- "kind": "土地造成工事",
- "method": "土地造成工"
}
}
], - "design_field": {
- "code": "0111000",
- "name": {
- "field": "地質",
- "first_level": "地下水",
- "second_level": "調査・計画",
- "third_level": "水文調査",
- "fourth_level": "河川"
}
}, - "client_organization_code": "00101001",
- "construction_industry_code": "01",
- "construction_field_code": "02",
- "construction_kind_and_method_codes": [
- {
- "code": "290"
}
], - "design_field_code": "0111000"
}
{- "product": {
- "id": 10,
- "name": "国道○号○○舗装修繕工事",
- "client_name": "国土交通省○○地方整備局○○事務所",
- "contractor_name": "○○建設株式会社△△組共同企業体(代表:○○建設株式会社)",
- "start_date": "2017-11-01",
- "end_date": "2019-03-26",
- "addresses": [
- {
- "address_names": [
- {
- "name": "サンプル市町村"
}
], - "prefecture_and_cities": [
- {
- "code": "01101",
- "name": {
- "prefecture": "北海道",
- "city": "札幌市"
}
}
], - "address_codes": [
- {
- "code": "01102"
}
]
}
], - "point_locations": [
- {
- "lat": 33.034,
- "lng": 123.034
}
], - "line_locations": [
- {
- "start_lat": 33.035,
- "start_lng": 123.034,
- "end_lat": 34.035,
- "end_lng": 124.034
}
], - "area_locations": [
- {
- "northern_lat": 33.035,
- "eastern_lng": 123.034,
- "southern_lat": 34.035,
- "western_lng": 124.034
}
], - "overview": "掘削工8500m3、土留め工2800m2、埋戻し工9500m3、路面覆工300m2",
- "amount": 10000000,
- "corins_tecris_number": "12345678K",
- "design_document_code": "207011110123",
- "client_corporate_number": "0000000102004",
- "contractor_corporate_number": "9999999999999",
- "keyword": "サンプル キーワード",
- "client_organization": {
- "code": "00101001",
- "name": {
- "first_level": "国の機関",
- "second_level": "内閣府",
- "third_level": "(内部部局)",
- "fourth_level": "(大臣官房)"
}
}, - "construction_industry": {
- "code": "01",
- "name": "土木一式工事"
}, - "construction_field": {
- "code": "01",
- "name": "河川"
}, - "construction_kind_and_methods": [
- {
- "code": "290",
- "name": {
- "kind": "土地造成工事",
- "method": "土地造成工"
}
}
], - "design_field": {
- "code": "0111000",
- "name": {
- "field": "地質",
- "first_level": "地下水",
- "second_level": "調査・計画",
- "third_level": "水文調査",
- "fourth_level": "河川"
}
}, - "client_organization_code": "00101001",
- "construction_industry_code": "01",
- "construction_field_code": "02",
- "construction_kind_and_method_codes": [
- {
- "code": "290"
}
], - "design_field_code": "0111000",
- "kind": "CONSTRUCTION",
- "status": "UNAPPROVED"
}
}
公開されている工事・業務データ一覧を検索する
q | string 文字列検索文字列で検索を行う。文字列は一部を除き部分一致検索される。パラメータを半角/全角スペースで区切るとOR検索が行われる。 完全一致検索が行われるのは以下のデータ
|
items | string 成果物の絞り込み検索成果物の有無で絞り込み検索を行う以下の文字列を指定して絞り込みができる 指定された文字列以外の場合、この絞り込み検索は無視される。
|
kind | string 「種別(kind)」の絞り込み検索「種別(kind)」で絞り込み検索を行う。文字列は完全一致検索される。パラメータを半角/全角スペースで区切るとOR検索が行われる。 種別絞り込み検索で利用できる文字列は以下の通り。
|
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を指定しない場合、昇順でソートされる。指定できるフィールド名は以下の通り。
|
direction | string 昇順/降順設定ソートの昇順/降順を設定する。昇順(asc)または降順(desc)を指定する。 |
{- "contents": [
- {
- "id": 10,
- "name": "国道○号○○舗装修繕工事",
- "client_name": "国土交通省○○地方整備局○○事務所",
- "contractor_name": "○○建設株式会社△△組共同企業体(代表:○○建設株式会社)",
- "start_date": "2017-11-01",
- "end_date": "2019-03-26",
- "addresses": [
- {
- "address_names": [
- {
- "name": "サンプル市町村"
}
], - "prefecture_and_cities": [
- {
- "code": "01101",
- "name": {
- "prefecture": "北海道",
- "city": "札幌市"
}
}
], - "address_codes": [
- {
- "code": "01102"
}
]
}
], - "point_locations": [
- {
- "lat": 33.034,
- "lng": 123.034
}
], - "line_locations": [
- {
- "start_lat": 33.035,
- "start_lng": 123.034,
- "end_lat": 34.035,
- "end_lng": 124.034
}
], - "area_locations": [
- {
- "northern_lat": 33.035,
- "eastern_lng": 123.034,
- "southern_lat": 34.035,
- "western_lng": 124.034
}
], - "overview": "掘削工8500m3、土留め工2800m2、埋戻し工9500m3、路面覆工300m2",
- "amount": 10000000,
- "corins_tecris_number": "12345678K",
- "design_document_code": "207011110123",
- "client_corporate_number": "0000000102004",
- "contractor_corporate_number": "9999999999999",
- "keyword": "サンプル キーワード",
- "client_organization": {
- "code": "00101001",
- "name": {
- "first_level": "国の機関",
- "second_level": "内閣府",
- "third_level": "(内部部局)",
- "fourth_level": "(大臣官房)"
}
}, - "construction_industry": {
- "code": "01",
- "name": "土木一式工事"
}, - "construction_field": {
- "code": "01",
- "name": "河川"
}, - "construction_kind_and_methods": [
- {
- "code": "290",
- "name": {
- "kind": "土地造成工事",
- "method": "土地造成工"
}
}
], - "design_field": {
- "code": "0111000",
- "name": {
- "field": "地質",
- "first_level": "地下水",
- "second_level": "調査・計画",
- "third_level": "水文調査",
- "fourth_level": "河川"
}
}, - "client_organization_code": "00101001",
- "construction_industry_code": "01",
- "construction_field_code": "02",
- "construction_kind_and_method_codes": [
- {
- "code": "290"
}
], - "design_field_code": "0111000",
- "kind": "CONSTRUCTION",
- "status": "UNAPPROVED"
}
], - "pagination": {
- "page": 1,
- "max_count": 1,
- "per_page": 20,
- "current_count": 1,
- "has_prev": false,
- "has_next": false,
- "max_page_count": 1
}
}
{- "product": {
- "id": 10,
- "name": "国道○号○○舗装修繕工事",
- "client_name": "国土交通省○○地方整備局○○事務所",
- "contractor_name": "○○建設株式会社△△組共同企業体(代表:○○建設株式会社)",
- "start_date": "2017-11-01",
- "end_date": "2019-03-26",
- "addresses": [
- {
- "address_names": [
- {
- "name": "サンプル市町村"
}
], - "prefecture_and_cities": [
- {
- "code": "01101",
- "name": {
- "prefecture": "北海道",
- "city": "札幌市"
}
}
], - "address_codes": [
- {
- "code": "01102"
}
]
}
], - "point_locations": [
- {
- "lat": 33.034,
- "lng": 123.034
}
], - "line_locations": [
- {
- "start_lat": 33.035,
- "start_lng": 123.034,
- "end_lat": 34.035,
- "end_lng": 124.034
}
], - "area_locations": [
- {
- "northern_lat": 33.035,
- "eastern_lng": 123.034,
- "southern_lat": 34.035,
- "western_lng": 124.034
}
], - "overview": "掘削工8500m3、土留め工2800m2、埋戻し工9500m3、路面覆工300m2",
- "amount": 10000000,
- "corins_tecris_number": "12345678K",
- "design_document_code": "207011110123",
- "client_corporate_number": "0000000102004",
- "contractor_corporate_number": "9999999999999",
- "keyword": "サンプル キーワード",
- "client_organization": {
- "code": "00101001",
- "name": {
- "first_level": "国の機関",
- "second_level": "内閣府",
- "third_level": "(内部部局)",
- "fourth_level": "(大臣官房)"
}
}, - "construction_industry": {
- "code": "01",
- "name": "土木一式工事"
}, - "construction_field": {
- "code": "01",
- "name": "河川"
}, - "construction_kind_and_methods": [
- {
- "code": "290",
- "name": {
- "kind": "土地造成工事",
- "method": "土地造成工"
}
}
], - "design_field": {
- "code": "0111000",
- "name": {
- "field": "地質",
- "first_level": "地下水",
- "second_level": "調査・計画",
- "third_level": "水文調査",
- "fourth_level": "河川"
}
}, - "client_organization_code": "00101001",
- "construction_industry_code": "01",
- "construction_field_code": "02",
- "construction_kind_and_method_codes": [
- {
- "code": "290"
}
], - "design_field_code": "0111000",
- "kind": "CONSTRUCTION",
- "status": "UNAPPROVED"
}
}
(廃止理由)PUTメソッドはリソースの完全な置換を表すメソッドである
本APIにおける工事/業務データの更新は部分置換であり、メソッドのセマンティクスに合致しないため廃止する
本APIの代替としてPATCHメソッドを利用すること
product_id required | integer 工事/業務データID |
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) 場所情報(点)リスト | |
Array of objects (LineLocation) 場所情報(線)リスト | |
Array of objects (AreaLocation) 場所情報(面)リスト | |
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) 発注機関 | |
object (ConstructionIndustry) 工事業種 | |
object (ConstructionField) 工事分野コード | |
Array of objects (ConstructionKindAndMethod) 工種・工法型式リスト | |
object (DesignField) 業務分野コード | |
client_organization_code | |
construction_industry_code | |
construction_field_code | |
Array of objects (ConstructionKindAndMethodCode) Deprecated 工種・工法型式コードリスト | |
design_field_code |
{- "kind": "CONSTRUCTION",
- "name": "国道○号○○舗装修繕工事",
- "client_name": "国土交通省○○地方整備局○○事務所",
- "contractor_name": "○○建設株式会社△△組共同企業体(代表:○○建設株式会社)",
- "start_date": "2017-11-01",
- "end_date": "2019-03-26",
- "addresses": [
- {
- "address_names": [
- {
- "name": "サンプル市町村"
}
], - "prefecture_and_cities": [
- {
- "code": "01101",
- "name": {
- "prefecture": "北海道",
- "city": "札幌市"
}
}
], - "address_codes": [
- {
- "code": "01102"
}
]
}
], - "point_locations": [
- {
- "lat": 33.034,
- "lng": 123.034
}
], - "line_locations": [
- {
- "start_lat": 33.035,
- "start_lng": 123.034,
- "end_lat": 34.035,
- "end_lng": 124.034
}
], - "area_locations": [
- {
- "northern_lat": 33.035,
- "eastern_lng": 123.034,
- "southern_lat": 34.035,
- "western_lng": 124.034
}
], - "overview": "掘削工8500m3、土留め工2800m2、埋戻し工9500m3、路面覆工300m2",
- "client_corporate_number": "0000000102004",
- "client_persons": [
- {
- "department": "○○部署",
- "name": "山田 太郎",
- "email": "t-yamada@example.com"
}
], - "contractor_persons": [
- {
- "department": "△△部署",
- "name": "田中 次郎",
- "email": "j-tanaka@example.com"
}
], - "amount": 10000000,
- "corins_tecris_number": "12345678K",
- "design_document_code": "207011110123",
- "keyword": "サンプル キーワード",
- "client_organization": {
- "code": "00101001",
- "name": {
- "first_level": "国の機関",
- "second_level": "内閣府",
- "third_level": "(内部部局)",
- "fourth_level": "(大臣官房)"
}
}, - "construction_industry": {
- "code": "01",
- "name": "土木一式工事"
}, - "construction_field": {
- "code": "01",
- "name": "河川"
}, - "construction_kind_and_methods": [
- {
- "code": "290",
- "name": {
- "kind": "土地造成工事",
- "method": "土地造成工"
}
}
], - "design_field": {
- "code": "0111000",
- "name": {
- "field": "地質",
- "first_level": "地下水",
- "second_level": "調査・計画",
- "third_level": "水文調査",
- "fourth_level": "河川"
}
}, - "client_organization_code": "00101001",
- "construction_industry_code": "01",
- "construction_field_code": "02",
- "construction_kind_and_method_codes": [
- {
- "code": "290"
}
], - "design_field_code": "0111000"
}
{- "product": {
- "id": 10,
- "name": "国道○号○○舗装修繕工事",
- "client_name": "国土交通省○○地方整備局○○事務所",
- "contractor_name": "○○建設株式会社△△組共同企業体(代表:○○建設株式会社)",
- "start_date": "2017-11-01",
- "end_date": "2019-03-26",
- "addresses": [
- {
- "address_names": [
- {
- "name": "サンプル市町村"
}
], - "prefecture_and_cities": [
- {
- "code": "01101",
- "name": {
- "prefecture": "北海道",
- "city": "札幌市"
}
}
], - "address_codes": [
- {
- "code": "01102"
}
]
}
], - "point_locations": [
- {
- "lat": 33.034,
- "lng": 123.034
}
], - "line_locations": [
- {
- "start_lat": 33.035,
- "start_lng": 123.034,
- "end_lat": 34.035,
- "end_lng": 124.034
}
], - "area_locations": [
- {
- "northern_lat": 33.035,
- "eastern_lng": 123.034,
- "southern_lat": 34.035,
- "western_lng": 124.034
}
], - "overview": "掘削工8500m3、土留め工2800m2、埋戻し工9500m3、路面覆工300m2",
- "amount": 10000000,
- "corins_tecris_number": "12345678K",
- "design_document_code": "207011110123",
- "client_corporate_number": "0000000102004",
- "contractor_corporate_number": "9999999999999",
- "keyword": "サンプル キーワード",
- "client_organization": {
- "code": "00101001",
- "name": {
- "first_level": "国の機関",
- "second_level": "内閣府",
- "third_level": "(内部部局)",
- "fourth_level": "(大臣官房)"
}
}, - "construction_industry": {
- "code": "01",
- "name": "土木一式工事"
}, - "construction_field": {
- "code": "01",
- "name": "河川"
}, - "construction_kind_and_methods": [
- {
- "code": "290",
- "name": {
- "kind": "土地造成工事",
- "method": "土地造成工"
}
}
], - "design_field": {
- "code": "0111000",
- "name": {
- "field": "地質",
- "first_level": "地下水",
- "second_level": "調査・計画",
- "third_level": "水文調査",
- "fourth_level": "河川"
}
}, - "client_organization_code": "00101001",
- "construction_industry_code": "01",
- "construction_field_code": "02",
- "construction_kind_and_method_codes": [
- {
- "code": "290"
}
], - "design_field_code": "0111000",
- "kind": "CONSTRUCTION",
- "status": "UNAPPROVED"
}
}
工事/業務データを更新する
product_id required | integer 工事/業務データID |
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) 場所情報(点)リスト | |
Array of objects (LineLocation) 場所情報(線)リスト | |
Array of objects (AreaLocation) 場所情報(面)リスト | |
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) 発注機関 | |
object (ConstructionIndustry) 工事業種 | |
object (ConstructionField) 工事分野コード | |
Array of objects (ConstructionKindAndMethod) 工種・工法型式リスト | |
object (DesignField) 業務分野コード | |
client_organization_code | |
construction_industry_code | |
construction_field_code | |
Array of objects (ConstructionKindAndMethodCode) Deprecated 工種・工法型式コードリスト | |
design_field_code |
{- "kind": "CONSTRUCTION",
- "name": "国道○号○○舗装修繕工事",
- "client_name": "国土交通省○○地方整備局○○事務所",
- "contractor_name": "○○建設株式会社△△組共同企業体(代表:○○建設株式会社)",
- "start_date": "2017-11-01",
- "end_date": "2019-03-26",
- "addresses": [
- {
- "address_names": [
- {
- "name": "サンプル市町村"
}
], - "prefecture_and_cities": [
- {
- "code": "01101",
- "name": {
- "prefecture": "北海道",
- "city": "札幌市"
}
}
], - "address_codes": [
- {
- "code": "01102"
}
]
}
], - "point_locations": [
- {
- "lat": 33.034,
- "lng": 123.034
}
], - "line_locations": [
- {
- "start_lat": 33.035,
- "start_lng": 123.034,
- "end_lat": 34.035,
- "end_lng": 124.034
}
], - "area_locations": [
- {
- "northern_lat": 33.035,
- "eastern_lng": 123.034,
- "southern_lat": 34.035,
- "western_lng": 124.034
}
], - "overview": "掘削工8500m3、土留め工2800m2、埋戻し工9500m3、路面覆工300m2",
- "client_corporate_number": "0000000102004",
- "client_persons": [
- {
- "department": "○○部署",
- "name": "山田 太郎",
- "email": "t-yamada@example.com"
}
], - "contractor_persons": [
- {
- "department": "△△部署",
- "name": "田中 次郎",
- "email": "j-tanaka@example.com"
}
], - "amount": 10000000,
- "corins_tecris_number": "12345678K",
- "design_document_code": "207011110123",
- "keyword": "サンプル キーワード",
- "client_organization": {
- "code": "00101001",
- "name": {
- "first_level": "国の機関",
- "second_level": "内閣府",
- "third_level": "(内部部局)",
- "fourth_level": "(大臣官房)"
}
}, - "construction_industry": {
- "code": "01",
- "name": "土木一式工事"
}, - "construction_field": {
- "code": "01",
- "name": "河川"
}, - "construction_kind_and_methods": [
- {
- "code": "290",
- "name": {
- "kind": "土地造成工事",
- "method": "土地造成工"
}
}
], - "design_field": {
- "code": "0111000",
- "name": {
- "field": "地質",
- "first_level": "地下水",
- "second_level": "調査・計画",
- "third_level": "水文調査",
- "fourth_level": "河川"
}
}, - "client_organization_code": "00101001",
- "construction_industry_code": "01",
- "construction_field_code": "02",
- "construction_kind_and_method_codes": [
- {
- "code": "290"
}
], - "design_field_code": "0111000"
}
{- "product": {
- "id": 10,
- "name": "国道○号○○舗装修繕工事",
- "client_name": "国土交通省○○地方整備局○○事務所",
- "contractor_name": "○○建設株式会社△△組共同企業体(代表:○○建設株式会社)",
- "start_date": "2017-11-01",
- "end_date": "2019-03-26",
- "addresses": [
- {
- "address_names": [
- {
- "name": "サンプル市町村"
}
], - "prefecture_and_cities": [
- {
- "code": "01101",
- "name": {
- "prefecture": "北海道",
- "city": "札幌市"
}
}
], - "address_codes": [
- {
- "code": "01102"
}
]
}
], - "point_locations": [
- {
- "lat": 33.034,
- "lng": 123.034
}
], - "line_locations": [
- {
- "start_lat": 33.035,
- "start_lng": 123.034,
- "end_lat": 34.035,
- "end_lng": 124.034
}
], - "area_locations": [
- {
- "northern_lat": 33.035,
- "eastern_lng": 123.034,
- "southern_lat": 34.035,
- "western_lng": 124.034
}
], - "overview": "掘削工8500m3、土留め工2800m2、埋戻し工9500m3、路面覆工300m2",
- "amount": 10000000,
- "corins_tecris_number": "12345678K",
- "design_document_code": "207011110123",
- "client_corporate_number": "0000000102004",
- "contractor_corporate_number": "9999999999999",
- "keyword": "サンプル キーワード",
- "client_organization": {
- "code": "00101001",
- "name": {
- "first_level": "国の機関",
- "second_level": "内閣府",
- "third_level": "(内部部局)",
- "fourth_level": "(大臣官房)"
}
}, - "construction_industry": {
- "code": "01",
- "name": "土木一式工事"
}, - "construction_field": {
- "code": "01",
- "name": "河川"
}, - "construction_kind_and_methods": [
- {
- "code": "290",
- "name": {
- "kind": "土地造成工事",
- "method": "土地造成工"
}
}
], - "design_field": {
- "code": "0111000",
- "name": {
- "field": "地質",
- "first_level": "地下水",
- "second_level": "調査・計画",
- "third_level": "水文調査",
- "fourth_level": "河川"
}
}, - "client_organization_code": "00101001",
- "construction_industry_code": "01",
- "construction_field_code": "02",
- "construction_kind_and_method_codes": [
- {
- "code": "290"
}
], - "design_field_code": "0111000",
- "kind": "CONSTRUCTION",
- "status": "UNAPPROVED"
}
}
工事データを差し戻しする
差し戻し完了後、差し戻したユーザが
product_id required | integer 工事/業務データID |
comment required | string 差し戻し理由 |
{- "comment": "データ不備により、差し戻します。"
}
{- "status": "success",
- "mail_send_fails": [
- {
- "department": "○○部署",
- "name": "山田 太郎",
- "email": "t-yamada@example.com"
}
]
}
ファイル簡易アップロードを行う。100MB以下のファイルをアップロードできる
100MB以上のファイルをアップロードしたい場合は、分割アップロードを行うこと
product_id required | integer 工事/業務データID |
folder_path required | string アップロードするファイルを配置するフォルダパス 例) test/file |
file required | string <binary> ファイルデータ |
{- "status": "success"
}
成果物ファイルを取得する。
product_id required | integer 工事/業務データID |
file_path required | string 成果物のファイルパス 例) test/file/sample.png |
metadata | string 成果物ファイルのメタデータを取得する。 このクエリパラメータは、成果物ファイルの存在確認等に有効。 |
inline | string ContentDispositionを付与しない成果物ファイルを取得する。 このクエリパラメータは、metadataクエリパラメータが設定されている場合は無視される。 |
json | string バイナリではなく、成果物ファイル取得先のURLをJSON形式で取得する。 成果物ファイル取得先のURLは非常に短い有効期限(15秒)を持つ。 このクエリパラメータは、metadataクエリパラメータが設定されている場合は無視される。 |
バイナリデータ
成果物ファイルの公開・非公開を変更する
product_id required | integer 工事/業務データID |
file_path required | string 成果物のファイルパス 例) test/file/sample.png |
state required | string 公開・非公開状態 PUBLISH:公開 UNPUBLISH:非公開 |
{- "state": "PUBLISH"
}
{- "name": "INDE_C.xml",
- "folder_path": "/ICON",
- "state": "PUBLISH",
- "size": 100,
- "create_date": "2020-05-01",
- "update_date": "2020-06-01"
}
成果物フォルダ内成果物一覧を取得する
product_id required | integer 工事/業務データID |
file_path required | string 成果物フォルダパス 例) test/folder |
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を指定しない場合、昇順でソートされる。指定できるフィールド名は以下の通り。
|
direction | string 昇順/降順設定ソートの昇順/降順を設定する。昇順(asc)または降順(desc)を指定する。 |
{- "contents": [
- {
- "name": "INDE_C.xml",
- "folder_path": "/ICON",
- "state": "PUBLISH",
- "size": 100,
- "is_folder": false,
- "create_date": "2020-05-01",
- "update_date": "2020-06-01"
}
], - "pagination": {
- "page": 1,
- "max_count": 1,
- "per_page": 20,
- "current_count": 1,
- "has_prev": false,
- "has_next": false,
- "max_page_count": 1
}
}
空の成果物フォルダを作成する
成果物フォルダは非公開の状態で作成される
product_id required | integer 工事/業務データID |
file_path required | string 成果物フォルダパス 例) test/folder |
foler_name | string フォルダ名 |
{- "foler_name": "empty_folder"
}
{- "name": "ICON",
- "folder_path": "/",
- "state": "PUBLISH",
- "size": 100,
- "is_folder": true,
- "create_date": "2020-05-01",
- "update_date": "2020-06-01"
}
成果物フォルダの公開・非公開を変更する
成果物フォルダ内にあるすべてのフォルダ・ファイルは再帰的に公開設定が変更される
product_id required | integer 工事/業務データID |
file_path required | string 成果物フォルダパス 例) test/folder |
state required | string 公開・非公開状態 PUBLISH:公開 UNPUBLISH:非公開 |
{- "state": "PUBLISH"
}
{- "name": "INDE_C.xml",
- "folder_path": "/ICON",
- "state": "PUBLISH",
- "size": 100,
- "is_folder": false,
- "create_date": "2020-05-01",
- "update_date": "2020-06-01"
}
フォルダをZIP形式でダウンロードする
フォルダ内のフォルダ・ファイルは再帰的にダウンロードされる
product_id required | integer 工事/業務データID |
folder_path required | string ダウンロードするフォルダパス 例) test/folder |
json | string バイナリではなく、ZIP形式のフォルダ取得先のURLをJSON形式で取得する。 ZIP形式のフォルダ取得先のURLは非常に短い有効期限(15秒)を持つ。 |
バイナリデータ
フォルダ内のファイル・フォルダを選択して削除する
フォルダ内のフォルダ・ファイルは再帰的に削除される
product_id required | integer 工事/業務データID |
folder_path required | string 対象フォルダパス 例) test/folder |
選択したパス配列
selects required | Array of arrays 削除するファイル・フォルダパスの配列 |
{- "selects": [
- "test.txt",
- "example/"
]
}
{- "status": "success"
}
APIを利用しているユーザが関連している工事・業務データ一覧を検索する
q | string 文字列検索文字列で検索を行う。文字列は一部を除き部分一致検索される。パラメータを半角/全角スペースで区切るとOR検索が行われる。 完全一致検索が行われるのは以下のデータ
|
items | string 成果物の絞り込み検索成果物の有無で絞り込み検索を行う以下の文字列を指定して絞り込みができる 指定された文字列以外の場合、この絞り込み検索は無視される。
|
kind | string 「種別(kind)」の絞り込み検索「種別(kind)」で絞り込み検索を行う。文字列は完全一致検索される。パラメータを半角/全角スペースで区切るとOR検索が行われる。 種別絞り込み検索で利用できる文字列は以下の通り。
|
status | string 「状態(status)」の絞り込み検索「状態(status)」で絞り込み検索を行う。文字列は完全一致検索される。パラメータを半角/全角スペースで区切るとOR検索が行われる。 状態絞り込み検索で利用できる文字列は以下の通り。
|
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を指定しない場合、昇順でソートされる。指定できるフィールド名は以下の通り。
|
direction | string 昇順/降順設定ソートの昇順/降順を設定する。昇順(asc)または降順(desc)を指定する。 |
{- "contents": [
- {
- "id": 10,
- "name": "国道○号○○舗装修繕工事",
- "client_name": "国土交通省○○地方整備局○○事務所",
- "contractor_name": "○○建設株式会社△△組共同企業体(代表:○○建設株式会社)",
- "start_date": "2017-11-01",
- "end_date": "2019-03-26",
- "addresses": [
- {
- "address_names": [
- {
- "name": "サンプル市町村"
}
], - "prefecture_and_cities": [
- {
- "code": "01101",
- "name": {
- "prefecture": "北海道",
- "city": "札幌市"
}
}
], - "address_codes": [
- {
- "code": "01102"
}
]
}
], - "point_locations": [
- {
- "lat": 33.034,
- "lng": 123.034
}
], - "line_locations": [
- {
- "start_lat": 33.035,
- "start_lng": 123.034,
- "end_lat": 34.035,
- "end_lng": 124.034
}
], - "area_locations": [
- {
- "northern_lat": 33.035,
- "eastern_lng": 123.034,
- "southern_lat": 34.035,
- "western_lng": 124.034
}
], - "overview": "掘削工8500m3、土留め工2800m2、埋戻し工9500m3、路面覆工300m2",
- "amount": 10000000,
- "corins_tecris_number": "12345678K",
- "design_document_code": "207011110123",
- "client_corporate_number": "0000000102004",
- "contractor_corporate_number": "9999999999999",
- "keyword": "サンプル キーワード",
- "client_organization": {
- "code": "00101001",
- "name": {
- "first_level": "国の機関",
- "second_level": "内閣府",
- "third_level": "(内部部局)",
- "fourth_level": "(大臣官房)"
}
}, - "construction_industry": {
- "code": "01",
- "name": "土木一式工事"
}, - "construction_field": {
- "code": "01",
- "name": "河川"
}, - "construction_kind_and_methods": [
- {
- "code": "290",
- "name": {
- "kind": "土地造成工事",
- "method": "土地造成工"
}
}
], - "design_field": {
- "code": "0111000",
- "name": {
- "field": "地質",
- "first_level": "地下水",
- "second_level": "調査・計画",
- "third_level": "水文調査",
- "fourth_level": "河川"
}
}, - "client_organization_code": "00101001",
- "construction_industry_code": "01",
- "construction_field_code": "02",
- "construction_kind_and_method_codes": [
- {
- "code": "290"
}
], - "design_field_code": "0111000",
- "kind": "CONSTRUCTION",
- "status": "UNAPPROVED"
}
], - "pagination": {
- "page": 1,
- "max_count": 1,
- "per_page": 20,
- "current_count": 1,
- "has_prev": false,
- "has_next": false,
- "max_page_count": 1
}
}