Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Table of Contents

...

Specification

Page Properties


Specification

Status
colourGreen
titledone
 

Apiary
Status
colourGreen
titledone
 create-substance
JSON Schema request
Status
colourGreen
titledone
 new_substance_schema.json
JSON Schema response

Status
colourGreen
titledone
 create_substance_response.json


Purpose

This WS is designed to create new Substance (post).

APIary 

create-substance

Input parameters

  • name
  • name_original
  • sctid

...

  1. Verify the validity of access token
  2. Check user scope (scope = 'substanse:write') in order to perform this action
    1. In case error - generate 401 response

...

Validate request using JSON schema (new_substance_schema.json)

Create new Substance

  1. Create new record in innms with status INACTIVE
  2. Fill data


Destination
Source
id
name$.name
name_original$.name_original
sctid$.sctid
is_active TRUE
inserted_at:timestamp
inserted_byuser_id
updated_at:timestamp
updated_byuser_id

Prepare & return response data structure

...