අනුවාදය 2.0 - නොවැම්බර් 2021
Web සේවා යෙදුම් ක්‍රමලේඛන අතුරුමුහුණත් මෘදුකාංගය
පරිශීලක මාර්ගෝපදේශය

Web සේවා යෙදුම් ක්‍රමලේඛන අතුරුමුහුණත් මෘදුකාංගය

හැඳින්වීම

රසායනාගාර එකතු කරන්නා Web සේවා යෙදුම් ක්‍රමලේඛන අතුරුමුහුණත (API) තෙවන පාර්ශවීය යෙදුම් වලට LabCollector හි දත්ත සමුදාය (මොඩියුල) සහ ඇඩෝන (ELN සහ LSM) සමඟ අන්තර් ක්‍රියා කිරීමට ඉඩ සලසයි.
API ඒකාකාර සම්පත් හඳුනාගැනීම් (URI) හරහා සම්පත් වෙත ප්‍රවේශ වීමට සහ ඒවා මත ක්‍රියා කිරීමට ඉඩ සලසන නියෝජිත රාජ්‍ය මාරු (REST) ​​ගෘහ නිර්මාණ ශිල්පයක් මත පදනම් වේ.
සටහන: 2017 ජූනි මාසයේ සිට API v1 අත්හිටුවන ලද අතර සියලුම නව පරිණාමයන් API v2 තුළ ඇත.

LABCOLLECTOR API

2-1. API පිහිටුවීම
පළමුවෙන්ම, ඔබ ඔබගේ LabCollector මෘදුකාංගයේ ඔබගේ අයදුම්පත ප්‍රකාශ කළ යුතුය. යෙදුම් ප්‍රකාශන සැකසුම් පෝරමයට ප්‍රවේශ වීමට, සුපිරි පරිපාලක අයිතිවාසිකම් සමඟ LabCollector වෙත ලොග් වී පරිපාලක > සැකසුම් පිටුව වෙත යන්න. ඉන්පසු තෝරන්න Web සේවා API සබැඳිය. ඔබ දැන් ඉන්නේ Web සේවා API යෙදුම් කළමනාකරණ පිටුව. නව යෙදුමක් ප්‍රකාශ කිරීමට, මෙම පෝරමය සම්පුර්ණ කරන්න:

• නම: ඔබගේ අයදුම්පතේ නම.
• මෙම යෙදුමට සම්බන්ධ මොඩියුල: යෙදුමට ප්‍රවේශ විය හැකි මොඩියුල තෝරන්න.
• පෙරනිමි ක්‍රියාකරු: ඔබට මෙම තොරතුරු එක් එක් ඉල්ලීම තුළ ඇතුළත් කිරීමට අවශ්‍ය නැතිනම් පෙරනිමි ක්‍රියාකරු වන සම්බන්ධතාව තෝරන්න.
• IP සීමා කිරීම: ආරක්ෂක විකල්පය ඔබට IP ලිපින ලැයිස්තුවක් ප්‍රකාශ කිරීමට ඉඩ සලසයි, එය ඔබට API මත ඉල්ලීම් කිරීමට ඉඩ දෙනු ඇත.

යෙදුම් ලැයිස්තුව ඔබගේ LabCollector සඳහා වන සියලුම යෙදුම් පෙන්වන අතර ඔබට ඕනෑම අවස්ථාවක, ඒවායේ විෂය පථය වෙනස් කළ හැක.
API වෙත ඉල්ලීම් අතරතුර ඔබගේ යෙදුම හඳුනා ගැනීමට අවශ්‍ය වන ටෝකනය වෙත ද ඔබට ප්‍රවේශය ඇත.

සටහන: මෙම විශේෂාංගය භාවිතා කිරීමට, ඔබ C සක්රිය කළ යුතුයurl ඔබගේ PHP මනාප මත. Linux හි, PHP-C ස්ථාපනය කරන්නurl පැකේජය.
වින්ඩෝස් මත සහ අපගේ ස්වයංක්‍රීය ස්ථාපකය සමඟින්, PHP.ini සංස්කරණය කරන්න සහ C සඳහා දිගු කිරීම් ඉවත් කරන්නurl (extension=php_curl.dll).
2-2. ඉල්ලීම්
තෙවන පාර්ශවීය යෙදුම් සහ LabCollector අතර සංවාදය web සේවා API HTTP 1.1 ප්‍රොටෝකෝලය මත පදනම් වේ.
2-2-1. API ක්‍රමය
ඔබට HTTP හෝ HTTPS ඉල්ලීම් යැවිය හැක web සම්පතක් මත ක්‍රියා කිරීමේ ක්‍රමයක් සහිත සේවාව.

• සම්පතක් කියවීම සඳහා GET ක්‍රමය
• නව සම්පතක් නිර්මාණය කිරීමට POST ක්රමය
• සම්පතක් වෙනස් කිරීමට PUT ක්‍රමය
• සම්පතක් මකා දැමීමට ක්‍රමය DELETE කරන්න

2-2-2. ශීර්ෂ
API වෙත ඉල්ලීමක් සඳහා නිශ්චිත HTTP/HTTPS ශීර්ෂ කිහිපයක් අවශ්‍ය වේ:

• පිළිගන්න ශීර්ෂය ඔබගේ ඉල්ලීමේ අපේක්ෂිත ප්‍රතිචාර ආකෘතිය, පෙළ/XML, හෝ යෙදුම/JSON අර්ථ දක්වයි.
• X-LC-APP-Auth ශීර්ෂකය යනු ඔබ API වෙත ඔබගේ ඉල්ලීම අනුමත කිරීමට අවශ්‍ය වන ඔබගේ යෙදුම් ටෝකනය තබන ස්ථානයයි.
• X-LC-APP-Charset ශීර්ෂකය ඔබගේ යෙදුමේ අක්ෂර කේතනය නිර්වචනය කරයි. එය API හට සුදුසු කේතනය සමඟ ප්‍රතිචාරය ආපසු යැවීමට සහ ඔබේ POST සහ PUT ඉල්ලීම් LabCollector හි අක්ෂර කේතනය (ISO 8859-1) වෙත නිවැරදිව පරිවර්තනය කිරීමට ඉඩ සලසයි.

2-2-3. මෙවලම
ඔබට Postman (Postman) ලෙස යම් මෘදුකාංග යෙදුමක් සමඟින් දත්ත ලබා ගැනීමට හෝ API වෙත දත්ත යැවීමට උත්සාහ කළ හැක.https://www.getpostman.com/).

ඒකාකාර සම්පත් හඳුනාගැනීමේ යන්ත්‍රය (URI)

2-3-1. මෙතෝ ලබා ගන්නd
ජෙනරාල්
එක් එක් LabCollector මොඩියුල දත්ත අනන්‍ය URI එකක් මගින් හඳුනා ගැනේ (මොඩියුලයේ URI හි සම්පූර්ණ ලැයිස්තුවක් සඳහා ඇමුණුම බලන්න):
[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE] මෙම ඉල්ලීම මොඩියුලයක ඇති සියලුම දත්ත ලැයිස්තුවට පිළිතුරු දෙයි.
ඔබගේ URI වෙත පරාමිති එකතු කිරීමෙන් ඔබට මොඩියුල දත්ත සෙවීම කළ හැක. ඔබට ක්ෂේත්‍ර අගයකට ගැළපෙන මූල පදයක් සමඟ පරාමිතියක් සම්මත කළ හැක, වැනි:[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?name=[KEYWORD]උදා
[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?name=පළමු%20වාර්තාව
මෙම ඉල්ලීම ඔවුන්ගේ නම අගය "පළමු වාර්තාව" මූල පදය අඩංගු වාර්තා ආපසු ලබා දෙයි.
ඒවා සෙවීම් සහ පෙරීමේ ක්‍රියා සිදු කිරීමට API භාවිතා කරන සමහර අභිරුචි පරාමිති වේ.
අභිරුචි පරාමිතීන්

• එහි ID මගින් දත්ත සඳහන් කිරීමට record_id පරාමිතිය:

[PATH_TO_LABCOLLECTOR]/webසේවාව/v2/[MODULE]?record_id=[RECORD_ID] උදා [PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?record_id=1,19
මෙම ඉල්ලීම ID 1 සහ ID 19 සමඟ වාර්තා ලබා දෙයි. ඔබට ඒවා කොමාවකින් වෙන් කිරීමෙන් බහු ID සඳහන් කළ හැක.

• by_keywords පරාමිතිය මූල පද සෙවීමක් සිදු කරයි:

[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?by_keywords=[KEYWORD] උදා [PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?by_keywords=cell
මෙම ඉල්ලීම සියලුම වාර්තා වල සියලුම ක්ෂේත්‍ර වෙත සෙවීමක් සිදු කරන අතර ගැළපෙන කොටු ලබා දෙයි. ඔබට මූල පද කිහිපයක් කොමාවකින් වෙන් කිරීමෙන් ඒවා නියම කළ හැක.

• by_keywords පරාමිතිය මූල පද සෙවීමක් සිදු කරයි:

[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?by_keywords=[KEYWORD] උදා [PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?by_keywords=cell
මෙම ඉල්ලීම සියලුම වාර්තාවල සියලුම ක්ෂේත්‍ර වෙත සෙවීමක් සිදු කරන අතර ගැළපෙන කොටුවක් ලබා දෙයි. කොමාවකින් ඒවා වෙන් කිරීමෙන් ඔබට මූල පද කිහිපයක් නියම කළ හැක.

• ක්ෂේත්‍ර පරාමිති, ඔබට API ප්‍රතිචාරයේ සමහර ක්ෂේත්‍ර අගයන් පමණක් ලබා ගැනීමට අවශ්‍ය නම්:

[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?fields=[FIELD1],[FIELD2] උදා [PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?fields=count,name
මෙම ඉල්ලීම මොඩියුලයෙන් සියලුම වාර්තා ආපසු ලබා දෙයි, නමුත් ගණන් කිරීම සහ නම් ක්ෂේත්‍ර පමණක් ඇත. ඔබට ඒවා කොමාවකින් වෙන් කිරීමෙන් බහු ක්ෂේත්‍ර නියම කළ හැක.
ඉල්ලීම දැන් "තෝරන්න" වර්ගයේ අභිරුචි ක්ෂේත්‍ර සඳහා කොමාවකින් වෙන් කරන ලද බහු අගයන් පිළිගනී.

• search_on පරාමිතිය ඔබට දත්ත සෙවීමට ඉඩ සලසයි. පහත දැක්වෙන පරිදි දින පරාසය අනුව සෙවීමට ඔබට එය භාවිතා කළ හැක:

[PATH_TO_LABCOLLECTOR]/webසේවාව/v2/[මොඩියුලය]&
search_on=date_field&from=XXXXXX&to=ZZZZZZ
ඔබ FROM පමණක් භාවිතා කරන්නේ නම්, ප්‍රතිඵලය FROM දිනයට වඩා විශාල දින සියල්ල ලබා දෙනු ඇත. ඔබ පමණක් භාවිතා කරන්නේ නම්, එය මෙම දිනය දක්වා සියලු අගය ආපසු ලබා දෙනු ඇත.

• sort_by පරාමිතිය ඔබට ඔබගේ සෙවුම වර්ග කිරීමට ඉඩ දෙයි:

[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?sort_by=[FIELD1]_DESC
උදා [PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?sort_by=name_DESC
මෙම ඉල්ලීම නම් ක්ෂේත්‍රයේ අවරෝහණ අනුපිළිවෙලට වර්ග කර ඇති සියලුම වාර්තා ආපසු ලබා දෙයි. ඔබට එක් එක් ක්ෂේත්‍රය සඳහා කොමාවකින් සහ නිශ්චිත අනුපිළිවෙලින් ආරෝහණ _ASC" හෝ descendant "_DESC" මගින් වෙන් කිරීමෙන් බහු වර්ග කිරීම_නිශ්චය කළ හැක.

• limit_to පරාමිතිය ඔබට ප්‍රතිඵල ගණන සීමා කිරීමට ඉඩ දෙයි:

[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]?limit_to=0,10
මෙම ඉල්ලීම 10 දර්ශකයෙන් ආරම්භ වන වාර්තා 0 ක් ලබා දෙයි. ඔබ දර්ශකය සඳහන් නොකරන්නේ නම්, සඳහන් කර ඇති ප්‍රතිඵල ගණන පමණක් ආපසු ලබා දේ.
API විසින් ශීර්ෂ ප්‍රතිචාරයේ අභිරුචි ක්ෂේත්‍ර දෙකක් ලබා දෙයි, ශරීර ප්‍රතිචාරයේ ලබා දුන් ප්‍රතිඵල ගණන අඩංගු “X-LC-QUERY-RESULT” සහ ඔබේ සෙවුමට ගැළපෙන මුළු වාර්තා අඩංගු “X-LC-QUERY- TOTAL”.
සෑම වාර්තාවකටම අනන්‍ය URI එකක් ද ඇත:
[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]/[DATA_ID] මෙම ඉල්ලීම අද්විතීය වාර්තාවකට පිළිතුරු දෙයි. [DATA_ID] ඔබට ලබා ගැනීමට අවශ්‍ය වාර්තාවේ අනන්‍ය ID සමඟ ගැළපිය යුතුය.
ගබඩා කිරීම
ගබඩාවට සම්බන්ධ සෑම අයිතමයක් සඳහාම ඔබට Tube Sorter පෙරීමේ කාර්යයන් ද ඇත:
[PATH_TO_LABCOLLECTOR]/webservice/index.php?v=2&action=tube_sorter&box_i d=[BOX_ID] උදා [PATH_TO_LABCOLLECTOR]/webservice/index.php?v=2&action=tube_sorter&box_i d=34
මෙම ඉල්ලීම මගින් ටියුබ් සෝටර් වැනි පෙට්ටි හැඳුනුම්පත 34 මත ගබඩා තොරතුරු ලබා දේ. ඔබට ඒවා කොමාවකින් වෙන් කිරීමෙන් බහු ID සඳහන් කළ හැක.

[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=tube_sorter&box_i d=[BOX_ID]&record_name=[RECORD_NAME] උදා [PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=tube_sorter&box_i d=206&record_name=ST-260
[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=tube_sorter&recor d_name=[RECORD_NAME] උදා [PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=tube_sorter&recor d_name=ST-260
මෙම ඉල්ලීම් ST-260 නම් වාර්තාවක් මත පෙරීම සිදු කරයි. ඔබට ඒවා කොමාවකින් වෙන් කිරීමෙන් බහු වාර්තා නාම නියම කළ හැක. ඔබට කොටු හැඳුනුම්පත ද සඳහන් කළ හැක, මෙහි 206.[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=tube_sorter&box_n ame=[BOX_NAME] උදා [PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=tube_sorter&box_n ame=test-rack_06
මෙම ඉල්ලීම box test-rack_06 මත පෙරීම සිදු කරයි. කොමාවකින් වෙන් කිරීමෙන් ඔබට බහු කොටු නම් නියම කළ හැක.
action=tube_sorter සඳහා වෙනත් සෙවුම් පරාමිති විය හැක්කේ:

• ස්ථානය_id
• ස්ථානය_නම
• පහසුකම_id
• පහසුකම_නම
  එය හිස් පෙට්ටි ද ආපසු ලබා දෙනු ඇත.
• storage_sec පරාමිතිය ද්විතියික ආචයනය පිළිබඳ තොරතුරු ලබා ගැනීමට ඉඩ දෙයි.

[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]&data_id=[DATA_ID]& fields=storage_sec

නිෂ්පාදන ගොඩක්

• ක්‍රියාව get lot මඟින් ගොඩක් සහ ප්‍රතික්‍රියාකාරක තොරතුරු ලබා ගැනීමට ඉඩ සලසයි

[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getLot
[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getLot&lo t_id=1/LT
[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getLot&ch em_id=2
විකල්ප පරාමිති වන්නේ lot_id (ආකෘතිය 1 හෝ 1/LT) සහ chem_id වේ. එයට පරාමිති නොලැබේ නම්, එය සියලුම සක්‍රීය කොටස් ලබා ගනී.
වට්ටෝරුව
[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getRecipe s
[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getRecipe &recipe_id=[record_id] උදා [PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getRecipe &recipe_id=509
[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getRecipe Logs
[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getRecipe Report&log_id=[record_id] උදා [PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action=getRecipe Report&log_id=1218
IDs examples නමුත් මෙම ඇමතුම් වල අනිවාර්ය වේ.
වට්ටෝරු ලබා ගැනීම පහත තොරතුරු මුද්‍රණය කරයි: හැඳුනුම්පත, නම, විස්තරය, ප්‍රවර්ගය

get recipes එම recipe_id සඳහා පහත තොරතුරු මුද්‍රණය කරයි: id, නම, විස්තරය, ප්‍රවර්ගය, සහ පසුව සංරචක getRecipeLogs පහත තොරතුරු මුද්‍රණය කරයි: id, නම, විස්තරය, ප්‍රවර්ගය getRecipeReport එම log_id සඳහා PDF වාර්තාව PDF බවට විකේතනය කළ හැකි base64 ආකෘතිය යටතේ මුද්‍රණය කරයි.

2-3-2. POST ක්රමය
නව සම්පතක් නිර්මාණය කිරීම සඳහා, POST ක්‍රමය සමඟ ඉල්ලීමක් අපේක්ෂිත මොඩියුලය URI වෙත යවන්න:
[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE] ඔබගේ පරාමිති යතුරු ක්ෂේත්‍රයේ නමට ගැළපිය යුතුය.
නව වාර්තා නිර්මාණය කිරීමේදී (POST) හෝ යාවත්කාලීන කිරීමේදී (PUT) එකතු කර ඇති සුවිශේෂතා ක්ෂේත්‍ර සඳහා පරීක්ෂා කරන්න
ක්ෂේත්‍ර අනන්‍යතාව සඳහා එකම අගයක් සහිත වෙනත් වාර්තාවක් තිබේ නම්, API ක්‍රියාව සම්පූර්ණ නොකරන අතර 409 කේතය (ගැටුම) ලබා දෙනු ඇත, සහ පෙළ: 'XXX' ක්ෂේත්‍රය සඳහා අගය අද්විතීය විය යුතුය. 'YYY' අගය දැනටමත් 'ZZZ' වගුවේ පවතී. (තිර රුව බලන්න) 

සටහන: project_code ක්ෂේත්‍රය POST සහ PUT හි භාවිතා කළ හැකි අතර එය පෙළ අපේක්ෂා කරයි (ID නොවේ). එය නොපවතී නම් සහ ක්‍රියාකරුට ප්‍රමාණවත් අවසර තිබේ නම් (පරිපාලක හෝ සුපිරි පරිපාලක) ඔබට දැන් නව ව්‍යාපෘති කේතයක් සෑදිය හැක.

• ඇඩ්බොක්ස් ක්‍රියාව මඟින් ඔබට කොටුවක් සෑදීමට ඉඩ සලසයි

[PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2&action= addBox

• අවශ්ය පරාමිතීන්:
  o නම
  o වර්ගය (වලංගු වර්ගයක් විය යුතුය: box, box_nogrid, plate, microplate, visit be, bag, shelf part)
  o උපකරණ (ID හෝ නම සඳහා සහය වන අතර LabCollector ගබඩාවේ තිබිය යුතුය).
  o ප්‍රමාණය (පෙට්ටියේ වර්ගය මත රඳා පවතී: සංචාරයක් සඳහා සංඛ්‍යාත්මක විය යුතු අතර, පෙට්ටියක්, තහඩුවක් සහ ක්ෂුද්‍ර තහඩුවක් සඳහා ආකෘතිය (A:1.H:8) විය යුතුය)
• විකල්ප පරාමිතීන්:
  o විස්තරය
  o රාක්කය
  o රකින්නා

2-3-3. PUT ක්රමය
සම්පතක් වෙනස් කිරීම සඳහා, අවශ්‍ය වාර්තා URI වෙත PUT ක්‍රමය සමඟ ඉල්ලීමක් යවන්න:
[PATH_TO_LABCOLLECTOR]/webservice/v2/[MODULE]/[DATA_ID] ඔබේ පරාමිති යතුරු ඔබට වෙනස් කිරීමට අවශ්‍ය ක්ෂේත්‍රයේ නමට ගැළපිය යුතුය.
පහත ක්‍රියා සඳහා, PUT ඉල්ලීම් සඳහා, පරාමිති ශරීරය මත තිබිය යුතු බව සලකන්න (හි URL).
ද URL [PATH_TO_LABCOLLECTOR]/webservice/index.PHP?v=2
ශීර්ෂයන් වන්නේ: X-LC-APP-Auth, පිළිගන්න.

• පරිමාව ඉවත් කරන්න
  - පරාමිතීන්:
  o ඉවත් පරිමාව (අනිවාර්ය)
  o තීරු කේතය, අද්විතීය_කේතය, හෝ aliquot_barcode (ඒවායින් එකක් තිබිය යුතුය)
  o ප්රමාණය (අනිවාර්ය)
  - ප්‍රතිචාරය: හරි
  
• ගබඩාව ඉවත් කරන්න
  - පරාමිතීන්:
  o දුරස්ථ ගබඩාව (අනිවාර්ය)
  o තීරු කේතය, අද්විතීය_කේතය, හෝ aliquot_barcode (ඒවායින් එකක් තිබිය යුතුය)
  - ප්‍රතිචාරය: හරි
  
• රෙජිස්ට්රි පොත එකතු කරන්න
  – URL:
  [PATH_TO_LABCOLLECTOR]/webservice/index.php?v=2&module=[m odule] - පරාමිතීන්:
  o addRegistryBook (අනිවාර්ය)
  o record_id (අනිවාර්‍ය)
  o දිනය (අනිවාර්ය, ආකෘතිය yy yy/mm/dd හෝ yyyy-mm-dd)
  o අදහස් (අනිවාර්ය)
  o ක්‍රියාකරු (විකල්ප, එය එවන්නේ නැතිනම් API පෙරනිමි ක්‍රියාකරු භාවිතා කරනු ඇත)
  o ක්‍රියාව (විකල්ප, LC හි අර්ථ දක්වා ඇති වලංගු 'ගබඩා ක්‍රියා වර්ගය' විය යුතුය
  >පරිපාලක > මනාප > ක්‍රියාවලි සහ ක්‍රියා වර්ගය)
  - ප්‍රතිචාරය: හරි
  
• ද්විතියික ගබඩාව එක් කරන්න
  - පරාමිතීන්:
  o ද්විතියික ගබඩා එකතු කරන්න (අනිවාර්ය)
  o තීරු කේතය (අනිවාර්ය)
  o box_id (අනිවාර්ය)
  o box_details (අනිවාර්‍ය වන්නේ ජාලක බෙදුම්කරු, ටියුබ් ට්‍රේ සහ මයික්‍රොප්ලේට් සහිත පෙට්ටිය සඳහා පමණි. පෙට්ටිය ජාලකයක්, බෑගයක්, සංචාරයක් හෝ රාක්ක කොටසක් නොමැති නම්, එය අවශ්‍ය නොවේ)
  අද්විතීය_කේතය (විකල්ප)
  o පරිමාව (විකල්ප)
  o අදහස් (විකල්ප)
  o cap_color (විකල්ප)

සටහන: අනිවාර්ය පරාමිති නොමැති නම් දෝෂ පණිවිඩයක් ආපසු එවනු ලැබේ; තීරු කේතය නොමැති නම්; අනන්‍ය_කේතය තිබේ නම්, නමුත් එය අනන්‍ය නොවේ නම්; සහ, වර්ණය පවතින නමුත් එය නොපවතී නම්.
පරාමිතිය box_details නොලැබුනේ නම් සහ කොටුවේ වර්ගයට පිහිටීම අවශ්‍ය නම් (ජාලයක් සහිත පෙට්ටියක්, නල තැටියක් හෝ ක්ෂුද්‍ර තහඩුවක්), දෝෂ පණිවිඩයක් ආපසු එවනු ලැබේ. සටහන: project_code ක්ෂේත්‍රය POST සහ PUT හි භාවිතා කළ හැකි අතර එය පෙළ අපේක්ෂා කරයි (ID නොවේ). එය නොපවතී නම් සහ ක්‍රියාකරුට ප්‍රමාණවත් අවසර තිබේ නම් (පරිපාලක හෝ සුපිරි පරිපාලක) ඔබට දැන් නව ව්‍යාපෘති කේතයක් සෑදිය හැක.
2-3-4. DELETE ක්‍රමය
සම්පතක් මැකීමට, අවශ්‍ය වාර්තා URI වෙත DELETE ක්‍රමය සමඟ ඉල්ලීමක් යවන්න:
[PATH_TO_LABCOLLECTOR]/webසේවාව/v2/[MODULE]/[DATA_ID]

API දෝෂ පණිවිඩ

පණිවිඩය	ප්‍රතිචාර කේතය	විස්තරය
වෙත ප්‍රවේශ වීමට යෙදුම් සත්‍යාපනය අවශ්‍ය වේ Web සේවා'	401 අනවසර	ඉල්ලීමෙහි ශීර්ෂ පරාමිතිය X- LC-APP-Auth නැත නැතහොත් වලංගු අගයක් නොමැත
'වලංගු නොවන ක්‍රියාව xxx'	400 නරක ඉල්ලීමක්	පරාමිති ක්‍රියාව 'tube_sorter' ට වෙනස් අගයක් ඇත හෝ 'NetBackup'
සෙවුම් පරාමිති අතුරුදහන්!	400 නරක ඉල්ලීමක්	ඉල්ලීමෙහි Action=tube_sorter පරාමිතිය අඩංගු වේ නමුත් එය අවම වශයෙන් පහත පරාමිති වලින් එකක්වත් නොමැත: box_id, box_name, record_name, unique_code, barcode, aliquot_barcode
"XXX" මොඩියුලය නොපවතී!'	400 නරක ඉල්ලීමක්	'මොඩියුලය' පරාමිතියෙහි අගය GB එකතු කිරීමේ මොඩියුලයක් නොවේ
"XXX" මොඩියුලය මෙම දත්ත බෙදා නොගනී!'	403 තහනම්	'මොඩියුලය' පරාමිතියෙහි අගය පරීක්ෂා කර නැත LabCollector > Admin > Setup > Web සේවය
'ඉල්ලීමේ ආකෘතිය පිළිගනු නොලැබේ!'	415 සහාය නොදක්වන මාධ්‍ය වර්ගය	පිළිගන්න පරාමිතිය භාවිතා වේ, නමුත් අගය පිළිගත් අගයන්ගෙන් එකක් නොවේ: යෙදුම/XML හෝ යෙදුම/JSON
(හිස්)	406 පිළිගත නොහැකිය	ක්‍රමය පහත ඒවායින් එකක් විය යුතුය: GET, POST, PUT, DELETE
'දත්ත නොමැත.'	404 හමු නොවීය	මෙම ඉල්ලීමෙහි පරාමිති සමඟ දත්ත කිසිවක් හමු නොවිණි
'හරි.'	200 හරි	වාර්තාව සාර්ථකව යාවත්කාලීන කරන ලදී
'ගැටුම.'	409 ගැටුම	එකක් තිබෙන නිසා වාර්තාව යාවත්කාලීන කළ නොහැකි විය දත්තවල ගැටුම
මෙම මොඩියුලය සඳහා කිසිදු ජීවියෙකුගේ වටිනාකමක් නැත	404 හමු නොවීය	මොඩියුල පමණක් "විකාර", "samples" සහ microarrays" ජීවී අගයක් ඇත - ඔබ වැරදි දෙයක් තෝරා ඇත මොඩියුලය
මෙම මොඩියුලය සඳහා ප්‍රවර්ග අගයක් නොමැත	404 හමු නොවීය	'ඩොක්ස්' මොඩියුලයට පමණක් ප්‍රවර්ග ඇත - ඔබ තෝරා ඇත වැරදි මොඩියුලයක්
Webසේවාවට පරිශීලක සත්‍යාපනය අවශ්‍ය වේ	401 අනවසර	අත්හරින ලදී
ඔබේ IP එකට මෙයට ප්‍රවේශ වීමට අවසර නැත Web සේවා'	401 අනවසර	සේවාලාභී IP මේ සඳහා බලයලත් IP ලැයිස්තුවේ නොමැත Webසේවා (LC > Admin > Setup > Web සේවය)
ඔබගේ ඉල්ලීම අතරතුර දෝෂයක්, නව එකක් සෑදීමට පහත තොරතුරු අනිවාර්ය වේ වාර්තාව: X, Y, Z '	400 නරක ඉල්ලීමක්	X, Y, අනිවාර්ය ක්ෂේත්‍ර නොමැතිව නව දත්ත පළ කිරීමට උත්සාහ කරන්න Z
ඔබගේ ඉල්ලීම අතරතුර දෝෂයක් සිදුවී ඇත, පරිමාව ඉවත් කිරීමට පහත තොරතුරු අනිවාර්ය වේ: unique_code හෝ barcode හෝ aliquot_barcode, quantity, quantity	400 නරක ඉල්ලීමක්	අනිවාර්යයෙන් තොරව පරිමාව ඉවත් කිරීමට උත්සාහ කරන්න පරාමිති: අද්විතීය_කේතය හෝ තීරු කේතය හෝ aliquot_barcode, ප්රමාණය
ඔබගේ ඉල්ලීම අතරතුර දෝෂයක් සිදුවී ඇත, පහත තොරතුරු අනිවාර්ය වේ ගබඩාව ඉවත් කරන්න: unique_codeor තීරු කේතය හෝ aliquot_barcode, ප්‍රමාණය '	400 නරක ඉල්ලීමක්	අනිවාර්යයෙන් තොරව ගබඩාව ඉවත් කිරීමට උත්සාහ කරන්න පරාමිතිය: unique_code හෝ barcode හෝ aliquot_barcode
”	200 හරි	ඉල්ලා සිටි දත්ත සාර්ථකව ආපසු ලබා දෙන ලදී

ලැබ්කොලෙක්ටර් WEB සේවා API - ඇමුණුම

API හි URI පද්ධතිය සරල සහ පිරිසිදු එකක් භාවිතා කරයි URL. පහත වගුවේ සඳහන් URI භාවිතා කිරීමට Apache වෙතින් නැවත ලිවීමේ එන්ජිම සක්‍රීය කිරීමට වග බලා ගන්න. LabCollector සේවාදායකය නැවත ලිවීමේ එන්ජිමට සහය නොදක්වන්නේ නම් කරුණාකර සම්පූර්ණ එක භාවිතා කරන්න URL ඔබගේ ඉල්ලීම සඳහා රටාව (ද්විතියික URL එක් එක් පේළියේ).

UM		මොඩියුලය	විස්තරය
webසේවා/v2/strains webservice/index.PHP?v=2&module=strai ns	තනතුර ලබා ගන්න	වික්රියා සහ සෛල	සියලුම වාර්තා ලැයිස්තුව
webසේවාව/v2/strains/(DATA JD] webservice/index.PHP?v=2&module=strai ns&data jd.[DATA _ID]	දාන්න	වික්රියා සහ සෛල	අද්විතීය වාර්තාව
webසේවා/v2/strains/අභිරුචි ක්ෂේත්‍ර webservice/index.php?v=2&module=strai ns&getModuleCustomFields=1	ලබා ගන්න	වික්රියා සහ සෛල	අභිරුචි ක්ෂේත්ර ලැයිස්තුව
webසේවාව / v2 / වික්රියා / ජීවීන් webservice/index.PHP?v=2&module=strai ns&getModuleOrganisms=1	ලබා ගන්න	වික්රියා සහ සෛල ජීවීන්	ලැයිස්තුව
webසේවාව/v2/plasmids webservice/index.php?v=2&module=plas mids	තනතුර ලබා ගන්න	ප්ලාස්මිඩ්	සියලුම වාර්තා ලැයිස්තුව
webසේවාව/v2/plasmids/IDATAjD] webservice/index.php?v=2&module=plasmids&data _id=IDATA _ID]	ලබා ගන්න දාන්න	ප්ලාස්මිඩ්	අද්විතීය වාර්තාව
webසේවා/v2/ප්ලාස්මිඩ්/අභිරුචි ක්ෂේත්‍ර webservice/index.PHP?v=2&module=plas mids&getModuleCustomFields=1	ලබා ගන්න	ප්ලාස්මිඩ් ක්ෂේත්ර	අභිරුචි ලැයිස්තුව
webසේවාව/v2/primers webservice/index.PHP?v=2&module=pri mers	තනතුර ලබා ගන්න	ප්‍රයිමර්ස්	සියලුම වාර්තා ලැයිස්තුව
webservice/v2/primers/[DATA JD] webservice/index.PHP?v=2&module=pri mers&data _idADATA _ID]	PUT GET	ප්‍රයිමර්ස්	අද්විතීය වාර්තාව
webසේවා/v2/primers/අභිරුචි ක්ෂේත්‍ර	ලබා ගන්න	ප්‍රයිමර්ස්	අභිරුචි ක්ෂේත්ර ලැයිස්තුව

webservice/index.PHP?v=2&module=pri mers&getModuleCustomFields=1
webසේවා/v2/රසායන webservice/index.PHP?v=2&module=che micals	තනතුර ලබා ගන්න	ප්රතික්රියාකාරක සහ සැපයුම්	සියලුම වාර්තා ලැයිස්තුව
webservice/v2/chemicals/IDATA _ID] webservice/index.PHP?v=2&module=che micals&data_idADADATA _ID]	දාන්න	ප්රතික්රියාකාරක සහ සැපයුම්	අද්විතීය වාර්තාව
webසේවා/v2/රසායන/අභිරුචි ක්ෂේත්‍ර webservice/index.PHP?v=2&module=che micals&getModuleCustomFields=1	ලබා ගන්න	ප්‍රතික්‍රියාකාරක සහ සැපයුම් ක්ෂේත්‍ර	අභිරුචි ලැයිස්තුව
webසේවාව/v2/samples webservice/index.PHP?v=2&module=sam pies	තනතුර ලබා ගන්න	Samples	සියලුම වාර්තා ලැයිස්තුව
webසේවාව/v2/samples/IDTA_ID) web service/index.PHP?v=2&module=sam ples&data_id=[DATA _ID]	දාන්න	Samples	අද්විතීය වාර්තාව
webසේවාව/v2/samples / අභිරුචි ක්ෂේත්ර webservice/index.PHP?v=2&module=sam ples&getModuleCustomFields=1	ලබා ගන්න	Samples	අභිරුචි ක්ෂේත්ර ලැයිස්තුව
webසේවාව/v2/samples / ජීවීන් webservice/index.php?v=2&module=sam ples&getModuleOrganisms=1	ලබා ගන්න	Samples	ජීවීන්ගේ ලැයිස්තුව
webසේවාව/v2/samples/වර්ග webservice/index.PHP?v=2&module=sam ples&getModuleTypes=1	ලබා ගන්න	Samples	ගේ ලැයිස්තුවample වර්ග
webසේවා/v2/ප්‍රතිදේහ webservice/index.PHP?v=2&module=ප්‍රතිදේහ	තනතුර ලබා ගන්න	ප්‍රතිදේහ	සියලුම වාර්තා ලැයිස්තුව
webසේවාව/v2/ප්‍රතිදේහ/(DATA _iDi webservice/index.PHP?v=2&module=antibody&data_id=IDATA _ID]	දාන්න	ප්‍රතිදේහ	අද්විතීය වාර්තාව
webසේවා/v2/ප්‍රතිදේහ/අභිරුචි ක්ෂේත්‍ර webservice/index.PHP?v=2&module=antibody&getModuleCustomFields=1	ලබා ගන්න	ප්රතිදේහ ක්ෂේත්ර	අභිරුචි ලැයිස්තුව
webservice/v2/sequences webservice/index.PHP?v=2&module=seq uences	තනතුර ලබා ගන්න	අනුපිළිවෙලවල්	සියලුම වාර්තා ලැයිස්තුව

webservice/v2/sequences/(DATA _iDI webservice/index.PHP?v=2&module=seq uences&data _icHCIATA JD]	ලබා ගන්න දාන්න	අනුපිළිවෙලවල්	අද්විතීය වාර්තාව
webservice/v2/sequences/ custom fields webservice/index.PHP?v=2&module=seq uences&getModuleCustomFields=1	ලබා ගන්න	අනුපිළිවෙල ක්ෂේත්‍ර	අභිරුචි ලැයිස්තුව
webසේවාව/v2/සතුන් webservice/index.PHP?v=2&module=ani mats	තනතුර ලබා ගන්න	සතුන්	සියලුම වාර්තා ලැයිස්තුව
webසේවාව/v2/සතුන්/(DATA JD] webservice/index.PHP?v=2&module=ani mals&data _ick[DATA JD]	ලබා ගන්න දාන්න	සතුන්	අද්විතීය වාර්තාව
webසේවා/v2/සතුන්/අභිරුචි ක්ෂේත්‍ර webservice/index.PHP?v=2&module=ani malsketModuleCustomFields=1	ලබා ගන්න	සතුන්	අභිරුචි ක්ෂේත්ර ලැයිස්තුව
webසේවා/v2/උපකරණ webservice/index.php?v=2&module=equi pments	තනතුර ලබා ගන්න	උපකරණ	සියලුම වාර්තා ලැයිස්තුව
webසේවාව/v2/උපකරණ/PATA _el Webservice/index.php?v=2&module=equi pments&data _idADATA _ID]	දාන්න	උපකරණ	අද්විතීය වාර්තාව
webසේවා/v2/උපකරණ/අභිරුචි ක්ෂේත්‍ර webservice/index.PHP?v=2&module=equi pments&getModuleCustomFields=1	ලබා ගන්න	උපකරණ ක්ෂේත්ර	අභිරුචි ලැයිස්තුව
webසේවා/v2/ව්‍යුහයන් webservice/index.PHP?v=2&module=stru සුව කරයි	තනතුර ලබා ගන්න	රසායනික ව්යුහයන්	සියලුම වාර්තා ලැයිස්තුව
webසේවාව/v2/ව්‍යුහයන්/(DATA_ID] webservice/index.PHP?v=2&module=stru ctures&data jd=(DATA JD]	දාන්න	රසායනික ව්යුහයන්	අද්විතීය වාර්තාව
webසේවා/v2/ව්‍යුහයන්/අභිරුචි ක්ෂේත්‍ර webservice/index.PHP?v=2&module=stru cturesketModuleCustomFields=1	ලබා ගන්න	රසායනික ව්යුහයන්	අභිරුචි ක්ෂේත්ර ලැයිස්තුව
webසේවාව/v2/ලේඛන webservice/index.PHP?v=2&module=docs	තනතුර ලබා ගන්න	ලේඛන	සියලුම වාර්තා ලැයිස්තුව
webservice/v2/docs/(DATA JD] webservice/index.PHP?v=2&module=docs &data _idADATA _ID]	දාන්න	ලේඛන	අද්විතීය වාර්තාව

webසේවා/v2/docs/අභිරුචි ක්ෂේත්‍ර webservice/index.php?v=2&module=docs &getModuleCustomFields=1	ලබා ගන්න	ලේඛන	අභිරුචි ක්ෂේත්ර ලැයිස්තුව
webසේවාව/v2/ලේඛන/ප්‍රවර්ග webservice/index.PHP?v=2&module=docs &getModuleCategories=1	ලබා ගන්න	ලේඛන කාණ්ඩ	ලැයිස්තුව
webසේවාව/v2/පොත webservice/index.PHP?v=2&module=abo හරි	තනතුර ලබා ගන්න	ලිපින පොත	සියලුම වාර්තා ලැයිස්තුව
webසේවාව/v2/book/(DATA _ID] webservice/index.php?v=2&module=abo ok&data_idADADATA _ID]	දාන්න	ලිපින පොත	අද්විතීය වාර්තාව
webසේවා/v2/පොත/අභිරුචි ක්ෂේත්‍ර webservice/index.PHP?v=2&module=abo ok&getModuleCustomFields=1	ලබා ගන්න	ලිපින පොත	අභිරුචි ක්ෂේත්ර ලැයිස්තුව
webසේවාව/v2/පොත/ප්‍රවර්ග webservice/index.PHP?v=2&module=abo ok&getModuleCategories=1	ලබා ගන්න	ලිපින පොත් කාණ්ඩ	ලැයිස්තුව
webසේවා/v2/microarrays webservice/index.PHP?v=2&module=micr arrays	තනතුර ලබා ගන්න	ක්ෂුද්‍ර අරා	සියලුම වාර්තා ලැයිස්තුව
webservice/v2/microarrays/(DATA_ID] webservice/index.PHP?v=2&module=micr oarrays&data_id=[DATA_ID]	ලබා ගන්න දාන්න	ක්ෂුද්‍ර අරා	අද්විතීය වාර්තාව
webservice/v2/microarrays/ custom fields webservice/index.PHP?v=2&module=micr oarrays&getModuleCustomFields=1	ලබා ගන්න	ක්ෂුද්‍ර අරා	අභිරුචි ක්ෂේත්ර ලැයිස්තුව
webසේවා/v2/ක්ෂුද්‍ර කිරණ/ජීවීන් webservice/index.PHP?v=2&module=micr oarrays&getModuleOrganisms=1	ලබා ගන්න	ක්ෂුද්‍ර කිරණ ජීවීන්	ලැයිස්තුව
webසේවාව/v2/(CUSTOM_MODULE_NAM El webservice/index.PHP?v=2&module=ECU STOM_MODULE_NAMEI	තනතුර ලබා ගන්න	අභිරුචි මොඩියුලය	සියලුම වාර්තා ලැයිස්තුව
webසේවාව/v2/(CUSTOM_MODULE_NAM EMIDATA _ID] webservice/index.PHP?v=2&module=[CU STOM_MODULE_NAME] &data_id=[DATA _ID]	දාන්න	අභිරුචි මොඩියුලය	අද්විතීය වාර්තාව

webසේවාව/v2/(CUSTOM_MODULE_NAM Elicustomfields webservice/index.PHP?v=2&module=[CU STOM_MODULE_NAME184getModuleCust omFields=1

ලබා ගන්න

අභිරුචි මොඩියුලය

අභිරුචි ක්ෂේත්ර ලැයිස්තුව

http://www.labcollector.comsales@agilebio.com
AgileBio ඇමරිකා එක්සත් ජනපදය
5473 Kearny Villa Road Suite 255
සැන් ඩියාගෝ, CA 92123
ඇඑජ
දුරකථන: 347 368 1315
ෆැක්ස්: (800) 453 9128
http://www.agilebio.com
AgileBio මූලස්ථානය
75 රූ ද ලූර්මෙල්
75015 පැරිස්
ප්රංශය
දුරකථන: 01 41 79 15 85
ෆැක්ස්: 01 72 70 40 22

ලේඛන / සම්පත්

LabCollector Web සේවා යෙදුම් ක්‍රමලේඛන අතුරුමුහුණත් මෘදුකාංගය [pdf] පරිශීලක මාර්ගෝපදේශය Web සේවා යෙදුම් ක්‍රමලේඛන අතුරුමුහුණත, මෘදුකාංග, Web සේවා යෙදුම් ක්‍රමලේඛන අතුරුමුහුණත් මෘදුකාංගය

යොමු කිරීම්

• පරිශීලක අත්පොත