Jump to

• Request
• Response

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>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorCodeReferences-item

Type: object

Show Source

• 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.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for an agency that is associated with a code reference."
        },
        "CodeRefContent":{
            "type":"string",
            "description":"The detailed content of the code reference.",
            "title":"Content"
        },
        "CodeRefUrl":{
            "maxLength":250,
            "type":"string",
            "description":"The URL to the source document section for this code reference.",
            "title":"URL"
        },
        "CodeSection":{
            "maxLength":30,
            "type":"string",
            "description":"The section number that uniquely identifies the section of the source document for this code reference.",
            "title":"Code Section"
        },
        "CodeTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the code type that represents the source document for this code reference.",
            "title":"Code Type"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the code reference."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time of the creation of the code reference."
        },
        "Description":{
            "maxLength":200,
            "type":"string",
            "description":"The description of the code reference.",
            "title":"Description"
        },
        "EffectiveEndDate":{
            "format":"date",
            "type":"string",
            "description":"The effective end date of the code reference.",
            "title":"Effective End Date"
        },
        "EffectiveStartDate":{
            "format":"date",
            "type":"string",
            "description":"The effective start date of the code reference.",
            "title":"Effective Start Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the code reference was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the code reference."
        },
        "StandardName":{
            "maxLength":50,
            "type":"string",
            "description":"The title of the section that contains this code reference. This title comes from the source document.",
            "title":"Standard Name"
        },
        "StandardType":{
            "maxLength":30,
            "type":"string",
            "description":"The standard type that represents the field or discipline of the code reference.",
            "title":"Standard Type"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorCodeReferences-item

Type: object

Show Source

• 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.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for an agency that is associated with a code reference."
        },
        "CodeRefContent":{
            "type":"string",
            "description":"The detailed content of the code reference.",
            "title":"Content"
        },
        "CodeRefUrl":{
            "maxLength":250,
            "type":"string",
            "description":"The URL to the source document section for this code reference.",
            "title":"URL"
        },
        "CodeSection":{
            "maxLength":30,
            "type":"string",
            "description":"The section number that uniquely identifies the section of the source document for this code reference.",
            "title":"Code Section"
        },
        "CodeTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the code type that represents the source document for this code reference.",
            "title":"Code Type"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the code reference."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time of the creation of the code reference."
        },
        "Description":{
            "maxLength":200,
            "type":"string",
            "description":"The description of the code reference.",
            "title":"Description"
        },
        "EffectiveEndDate":{
            "format":"date",
            "type":"string",
            "description":"The effective end date of the code reference.",
            "title":"Effective End Date"
        },
        "EffectiveStartDate":{
            "format":"date",
            "type":"string",
            "description":"The effective start date of the code reference.",
            "title":"Effective Start Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the code reference was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the code reference."
        },
        "StandardName":{
            "maxLength":50,
            "type":"string",
            "description":"The title of the section that contains this code reference. This title comes from the source document.",
            "title":"Standard Name"
        },
        "StandardType":{
            "maxLength":30,
            "type":"string",
            "description":"The standard type that represents the field or discipline of the code reference.",
            "title":"Standard Type"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top