Sha256: 41e7ae575cfaf76b51c7c32e9422a1879af7127d12314b60343c2d68e09cd79f
Contents?: true
Size: 1.85 KB
Versions: 15
Compression:
Stored size: 1.85 KB
Contents
---
"$id": https://raw.githubusercontent.com/tcd/eddy/master/data/schema/segment_summary.json
"$schema": http://json-schema.org/draft-07/schema#
title: Segment Summary
description: A collection of Data Elements. Used in Companion Guides to define a Transaction Set.
required:
- id
type: object
additionalProperties: false
properties:
pos:
description: Specifies the order (usually in multiples of ten) in which the Segment appears in the Transaction Set.
type: string
id:
description: Short string identifying the Segment.
type: string
name:
description: Full name of the Segment.
type: string
purpose:
description: Documents the purpose of a Segment.
type: string
max_use:
description: Number of times a particular Segment may be repeated at its location in the Transaction Set.
type: integer
minimum: 1
notes:
description: "*Syntax*, *Semantic*, or *Comment* notes on a Segment."
type: string
loop:
description: Loop in which the Segment appears.
type: string
element_count:
description: Number of Data Elements included in the Segment. Used for comparison against standard segment definitions.
type: integer
minimum: 1
req:
description: Defines if/how the Segment is required.
type: string
enum: [M, O, X, Z]
level:
description: Indicates where the Segment is located in the Transaction Set.
type: string
enum:
- Heading
- Detail
- Summary
- Not Defined
usage:
description: Indicates whether or not the Segment is required by a specific business partner. This value takes precedence over `req` for validation.
type: string
enum:
- Must Use
- Used
elements:
description: Data Elements that comprise the Segment.
type: array
items:
"$ref": https://raw.githubusercontent.com/tcd/eddy/master/data/schema/element_summary.json
Version data entries
15 entries across 15 versions & 1 rubygems