Create a code reference
post
/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferences
Request
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for an agency that is associated with a code reference. -
CodeRefContent: string
(byte)
Title:
Content
The detailed content of the code reference. -
CodeRefUrl: string
Title:
URL
Maximum Length:250
The URL to the source document section for this code reference. -
CodeSection: string
Title:
Code Section
Maximum Length:30
The section number that uniquely identifies the section of the source document for this code reference. -
CodeTypeId: string
Title:
Code Type
Maximum Length:30
The unique identifier of the code type that represents the source document for this code reference. -
Description: string
Title:
Description
Maximum Length:200
The description of the code reference. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
The effective end date of the code reference. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
The effective start date of the code reference. -
StandardName: string
Title:
Standard Name
Maximum Length:50
The title of the section that contains this code reference. This title comes from the source document. -
StandardType: string
Title:
Standard Type
Maximum Length:30
The standard type that represents the field or discipline of the code reference.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorCodeReferences-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for an agency that is associated with a code reference. -
CodeRefContent: string
(byte)
Title:
Content
The detailed content of the code reference. -
CodeRefUrl: string
Title:
URL
Maximum Length:250
The URL to the source document section for this code reference. -
CodeSection: string
Title:
Code Section
Maximum Length:30
The section number that uniquely identifies the section of the source document for this code reference. -
CodeTypeId: string
Title:
Code Type
Maximum Length:30
The unique identifier of the code type that represents the source document for this code reference. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the code reference. -
CreationDate: string
(date-time)
Read Only:
true
The date and time of the creation of the code reference. -
Description: string
Title:
Description
Maximum Length:200
The description of the code reference. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
The effective end date of the code reference. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
The effective start date of the code reference. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the code reference was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the code reference. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StandardName: string
Title:
Standard Name
Maximum Length:50
The title of the section that contains this code reference. This title comes from the source document. -
StandardType: string
Title:
Standard Type
Maximum Length:30
The standard type that represents the field or discipline of the code reference.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.