Jump to

• Request
• Response

Update a code reference key is not supported

patch

/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferencesKeys/{publicSectorCodeReferencesKeysUniqID}

Request

Path Parameters

• publicSectorCodeReferencesKeysUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- StandardType, StandardName, CodeSection, EffectiveStartDate and EffectiveEndDate ---for the Code References Keys resource and used to uniquely identify an instance of Code References Keys. The client should not generate the hash key value. Instead, the client should query on the Code References Keys collection resource with a filter on the primary key values in order to navigate to a specific instance of Code References Keys.
  
  For example: publicSectorCodeReferencesKeys?q=StandardType=<value1>;StandardName=<value2>;CodeSection=<value3>;EffectiveStartDate=<value4>;EffectiveEndDate=<value5>

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : publicSectorCodeReferencesKeys-item-response

Type: object

Show Source

• CodeRefUrl: string
  Read Only: true

  Maximum Length: 250

  The URL to the source document section for this code reference.
• CodeSection: string
  Read Only: true

  Maximum Length: 30

  The section number that uniquely identifies the section of the source document for this code reference.
• CodeTypeId: string
  Read Only: true

  Maximum Length: 30

  The unique identifier of the code type that represents the source document for this code reference.
• Description: string
  Read Only: true

  Maximum Length: 200

  The description of the code reference.
• EffectiveEndDate: string (date)
  Read Only: true

  The effective end date of the code reference.
• EffectiveStartDate: string (date)
  Read Only: true

  The effective start date of the code reference.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• StandardName: string
  Read Only: true

  Maximum Length: 50

  The title of the section that contains this code reference. This title comes from the source document.
• StandardType: string
  Read Only: true

  Maximum Length: 255

  The standard type that represents the field or discipline of the code reference.

{
    "type":"object",
    "properties":{
        "CodeRefUrl":{
            "maxLength":"250",
            "type":"string",
            "description":"The URL to the source document section for this code reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"200",
            "type":"string",
            "description":"The description of the code reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CodeSection":{
            "maxLength":"30",
            "type":"string",
            "description":"The section number that uniquely identifies the section of the source document for this code reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The effective end date of the code reference.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CodeTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the code type that represents the source document for this code reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StandardName":{
            "maxLength":"50",
            "type":"string",
            "description":"The title of the section that contains this code reference. This title comes from the source document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The effective start date of the code reference.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StandardType":{
            "maxLength":"255",
            "type":"string",
            "description":"The standard type that represents the field or discipline of the code reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top