Jump to

• Request
• Response

Update a date range for a classification

patch

/fscmRestApi/resources/11.13.18.05/publicSectorGlobalAttributes/{publicSectorGlobalAttributesUniqID}

Request

Path Parameters

• publicSectorGlobalAttributesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId, Classification, EffectiveEndDate and EffectiveStartDate ---for the Global Attributes Date Range Details resource and used to uniquely identify an instance of Global Attributes Date Range Details. The client should not generate the hash key value. Instead, the client should query on the Global Attributes Date Range Details collection resource with a filter on the primary key values in order to navigate to a specific instance of Global Attributes Date Range Details.
  
  For example: publicSectorGlobalAttributes?q=AgencyId=<value1>;Classification=<value2>;EffectiveEndDate=<value3>;EffectiveStartDate=<value4>

Header Parameters

• Effective-Of: string
  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: string
  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: string
  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

• Description: string
  Maximum Length: 1000

  Description of the classification date range.
• EffectiveEndDate: string (date)
  Effective end date for the classification date range.
• GlobalAttributeLines: array Global Attributes Details
  Title: Global Attributes Details

  The Global Attribute Line resource is used to manage global attributes for a given classification.

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the classification date range.",
            "nullable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Effective end date for the classification date range.",
            "format":"date",
            "nullable":false
        },
        "GlobalAttributeLines":{
            "title":"Global Attributes Details",
            "type":"array",
            "description":"The Global Attribute Line resource is used to manage global attributes for a given classification.",
            "items":{
                "$ref":"#/components/schemas/publicSectorGlobalAttributes-GlobalAttributeLines-item-patch-request"
            }
        }
    }
}

Nested Schema : Global Attributes Details

Type: array

Title: Global Attributes Details

The Global Attribute Line resource is used to manage global attributes for a given classification.

Show Source

• Array of: object publicSectorGlobalAttributes-GlobalAttributeLines-item-patch-request

{
    "title":"Global Attributes Details",
    "type":"array",
    "description":"The Global Attribute Line resource is used to manage global attributes for a given classification.",
    "items":{
        "$ref":"#/components/schemas/publicSectorGlobalAttributes-GlobalAttributeLines-item-patch-request"
    }
}

Nested Schema : publicSectorGlobalAttributes-GlobalAttributeLines-item-patch-request

Type: object

Show Source

• AttributeName: string
  Title: Attribute Name

  Maximum Length: 300

  Global attribute name.
• AttributeValue: number
  Title: Attribute Value

  Global attribute value.
• Description: string
  Maximum Length: 1000

  Global attribute description.
• EffectiveEndDate: string (date)
  Effective end date for the global attribute.
• EnabledFlag: string
  Maximum Length: 1

  Default Value: Y

  Flag indicating whether the attribute is enabled.

{
    "type":"object",
    "properties":{
        "AttributeName":{
            "title":"Attribute Name",
            "maxLength":300,
            "type":"string",
            "description":"Global attribute name.",
            "nullable":false
        },
        "AttributeValue":{
            "title":"Attribute Value",
            "type":"number",
            "description":"Global attribute value.",
            "nullable":false
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"Global attribute description.",
            "nullable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Effective end date for the global attribute.",
            "format":"date",
            "nullable":false
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Flag indicating whether the attribute is enabled.",
            "nullable":false,
            "default":"Y"
        }
    }
}

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 : publicSectorGlobalAttributes-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  Agency ID for the classification date range.
• Classification: string
  Maximum Length: 30

  Default Value: ORA_GBL

  Classification for the date range.
• Description: string
  Maximum Length: 1000

  Description of the classification date range.
• EffectiveEndDate: string (date)
  Effective end date for the classification date range.
• EffectiveStartDate: string (date)
  Effective start date for the classification date range.
• GlobalAttributeLines: array Global Attributes Details
  Title: Global Attributes Details

  The Global Attribute Line resource is used to manage global attributes for a given classification.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"Agency ID for the classification date range.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "Classification":{
            "maxLength":30,
            "type":"string",
            "description":"Classification for the date range.",
            "nullable":false,
            "default":"ORA_GBL",
            "x-queryable":true
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the classification date range.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Effective end date for the classification date range.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Effective start date for the classification date range.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "GlobalAttributeLines":{
            "title":"Global Attributes Details",
            "type":"array",
            "description":"The Global Attribute Line resource is used to manage global attributes for a given classification.",
            "items":{
                "$ref":"#/components/schemas/publicSectorGlobalAttributes-GlobalAttributeLines-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Global Attributes Details

Type: array

Title: Global Attributes Details

The Global Attribute Line resource is used to manage global attributes for a given classification.

Show Source

• Array of: object publicSectorGlobalAttributes-GlobalAttributeLines-item-response

{
    "title":"Global Attributes Details",
    "type":"array",
    "description":"The Global Attribute Line resource is used to manage global attributes for a given classification.",
    "items":{
        "$ref":"#/components/schemas/publicSectorGlobalAttributes-GlobalAttributeLines-item-response"
    }
}

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 : publicSectorGlobalAttributes-GlobalAttributeLines-item-response

Type: object

Show Source

• AgencyId: integer
  Default Value: 1

  Agency ID for the global attribute.
• AttributeName: string
  Title: Attribute Name

  Maximum Length: 300

  Global attribute name.
• AttributeValue: number
  Title: Attribute Value

  Global attribute value.
• Classification: string
  Maximum Length: 30

  Default Value: ORA_GBL

  Classification for the global attribute.
• Description: string
  Maximum Length: 1000

  Global attribute description.
• EffectiveEndDate: string (date)
  Effective end date for the global attribute.
• EffectiveStartDate: string (date)
  Effective start date for the global attribute.
• EnabledFlag: string
  Maximum Length: 1

  Default Value: Y

  Flag indicating whether the attribute is enabled.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"Agency ID for the global attribute.",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "AttributeName":{
            "title":"Attribute Name",
            "maxLength":300,
            "type":"string",
            "description":"Global attribute name.",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeValue":{
            "title":"Attribute Value",
            "type":"number",
            "description":"Global attribute value.",
            "nullable":false,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":30,
            "type":"string",
            "description":"Classification for the global attribute.",
            "nullable":false,
            "default":"ORA_GBL",
            "x-queryable":true
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"Global attribute description.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Effective end date for the global attribute.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Effective start date for the global attribute.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Flag indicating whether the attribute is enabled.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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."
        }
    }
}

Links

GlobalAttributeLines

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorGlobalAttributes/{publicSectorGlobalAttributesUniqID}/child/GlobalAttributeLines

Parameters:

• publicSectorGlobalAttributesUniqID: $request.path.publicSectorGlobalAttributesUniqID

The Global Attribute Line resource is used to manage global attributes for a given classification.

Back to Top