Update a code reference
patch
/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferences/{publicSectorCodeReferencesUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorCodeReferencesUniqID: integer
This is the hash key of the attributes which make up the composite key--- StandardType, StandardName, CodeSection, EffectiveStartDate and EffectiveEndDate ---for the Code References resource and used to uniquely identify an instance of Code References. The client should not generate the hash key value. Instead, the client should query on the Code References collection resource with a filter on the primary key values in order to navigate to a specific instance of Code References.
For example: publicSectorCodeReferences?q=StandardType=<value1>;StandardName=<value2>;CodeSection=<value3>;EffectiveStartDate=<value4>;EffectiveEndDate=<value5>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorCodeReferences-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier for an agency that is associated with a code reference.
-
CodeRefContent(optional):
string
Title:
Content
The detailed content of the code reference. -
CodeRefUrl(optional):
string
Title:
URL
Maximum Length:250
The URL to the source document section for this code reference. -
CodeSection(optional):
string
Title:
Code Section
Maximum Length:30
The section number that uniquely identifies the section of the source document for this code reference. -
CodeTypeId(optional):
string
Title:
Code Type
Maximum Length:30
The unique identifier of the code type that represents the source document for this code reference. -
CreatedBy(optional):
string
Maximum Length:
64
The user who created the code reference. -
CreationDate(optional):
string(date-time)
The date and time of the creation of the code reference.
-
Description(optional):
string
Title:
Description
Maximum Length:200
The description of the code reference. -
EffectiveEndDate(optional):
string(date)
Title:
Effective End Date
The effective end date of the code reference. -
EffectiveStartDate(optional):
string(date)
Title:
Effective Start Date
The effective start date of the code reference. -
LastUpdateDate(optional):
string(date-time)
The date and time when the code reference was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the code reference. -
links(optional):
array Items
Title:
Items
Link Relations -
StandardName(optional):
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(optional):
string
Title:
Standard Type
Maximum Length:30
The standard type that represents the field or discipline of the code reference.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorCodeReferences-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier for an agency that is associated with a code reference.
-
CodeRefContent(optional):
string
Title:
Content
The detailed content of the code reference. -
CodeRefUrl(optional):
string
Title:
URL
Maximum Length:250
The URL to the source document section for this code reference. -
CodeSection(optional):
string
Title:
Code Section
Maximum Length:30
The section number that uniquely identifies the section of the source document for this code reference. -
CodeTypeId(optional):
string
Title:
Code Type
Maximum Length:30
The unique identifier of the code type that represents the source document for this code reference. -
CreatedBy(optional):
string
Maximum Length:
64
The user who created the code reference. -
CreationDate(optional):
string(date-time)
The date and time of the creation of the code reference.
-
Description(optional):
string
Title:
Description
Maximum Length:200
The description of the code reference. -
EffectiveEndDate(optional):
string(date)
Title:
Effective End Date
The effective end date of the code reference. -
EffectiveStartDate(optional):
string(date)
Title:
Effective Start Date
The effective start date of the code reference. -
LastUpdateDate(optional):
string(date-time)
The date and time when the code reference was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the code reference. -
links(optional):
array Items
Title:
Items
Link Relations -
StandardName(optional):
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(optional):
string
Title:
Standard Type
Maximum Length:30
The standard type that represents the field or discipline of the code reference.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.