Update a B2B Schema
put
/ic/api/b2b/v1/schemas/{schemaId}
Updates a B2B schema with the specified schema ID. Before you modify a schema used by an active agreement, deactivate it.
Request
Path Parameters
-
schemaId(required): string
B2B schema ID.
Example:
/b2b/v1/schemas/SCH123
Supported Media Types
- application/json
Nested Schema : DocumentNode
Type:
Show Source
object
-
attr(required): object
Discriminator: objType
Discriminator:
{ "propertyName":"objType", "mapping":{ "CELMS":"#/components/schemas/ElementUI", "SEGS":"#/components/schemas/SegmentUI", "SEG_LOOP":"#/components/schemas/SegLoopUI", "ELMS":"#/components/schemas/ElementUI", "COMS":"#/components/schemas/CompositeUI" } }
-
children(required): array
children
Nested Schema : Discriminator: objType
Type:
object
Discriminator: objType
Discriminator Values
Show Source-
cmnts: string
-
msk: boolean
-
name: string
-
notes: string
-
objId: string
-
objType: string
-
posNo: string
-
purpose: string
-
r: boolean
-
req: string
-
rptCnt: string
-
usage: string
-
var: integer
(int32)
Match One Schema
Show Source
Nested Schema : SegmentUI
Match All
Show Source
-
object
Discriminator: objType
Discriminator:
{ "propertyName":"objType", "mapping":{ "CELMS":"#/components/schemas/ElementUI", "SEGS":"#/components/schemas/SegmentUI", "SEG_LOOP":"#/components/schemas/SegLoopUI", "ELMS":"#/components/schemas/ElementUI", "COMS":"#/components/schemas/CompositeUI" } }
-
object
SegmentUI-allOf[1]
Nested Schema : SegLoopUI
Match All
Show Source
-
object
Discriminator: objType
Discriminator:
{ "propertyName":"objType", "mapping":{ "CELMS":"#/components/schemas/ElementUI", "SEGS":"#/components/schemas/SegmentUI", "SEG_LOOP":"#/components/schemas/SegLoopUI", "ELMS":"#/components/schemas/ElementUI", "COMS":"#/components/schemas/CompositeUI" } }
-
object
SegLoopUI-allOf[1]
Nested Schema : ElementUI
Match All
Show Source
-
object
Discriminator: objType
Discriminator:
{ "propertyName":"objType", "mapping":{ "CELMS":"#/components/schemas/ElementUI", "SEGS":"#/components/schemas/SegmentUI", "SEG_LOOP":"#/components/schemas/SegLoopUI", "ELMS":"#/components/schemas/ElementUI", "COMS":"#/components/schemas/CompositeUI" } }
-
object
ElementUI-allOf[1]
Nested Schema : CompositeUI
Match All
Show Source
-
object
Discriminator: objType
Discriminator:
{ "propertyName":"objType", "mapping":{ "CELMS":"#/components/schemas/ElementUI", "SEGS":"#/components/schemas/SegmentUI", "SEG_LOOP":"#/components/schemas/SegLoopUI", "ELMS":"#/components/schemas/ElementUI", "COMS":"#/components/schemas/CompositeUI" } }
-
object
CompositeUI-allOf[1]
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : Object
Type:
object
400 Response
Bad request, malformed parameters
500 Response
Server error