Jump to

• Request
• Response

Update a lookup type

patch

/fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes/{publicSectorLookupTypesUniqID}

Request

Path Parameters

• publicSectorLookupTypesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- LookupType and ViewApplicationId ---for the Lookup Types resource and used to uniquely identify an instance of Lookup Types. The client should not generate the hash key value. Instead, the client should query on the Lookup Types collection resource with a filter on the primary key values in order to navigate to a specific instance of Lookup Types.
  
  For example: publicSectorLookupTypes?q=LookupType=<value1>;ViewApplicationId=<value2>

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

• CustomizationLevel: string
  Title: Configuration Level

  Maximum Length: 1

  Default Value: U

  The configuration level code such as system level or user level.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of the lookup type code.
• Meaning: string
  Title: Meaning

  Maximum Length: 80

  The meaning of the lookup type code.
• ModuleId: string
  Title: Module

  Maximum Length: 32

  The unique module identifier associated with a logical business area such as billing or payment.
• PscLookupValue: array Lookup Values
  Title: Lookup Values

  The lookup value resource is used to view, create, delete or modify lookup values associated with a lookup type. The object stores lookup value information such as lookup code and meaning.
• ReferenceGroupName: string
  Title: Reference Group Name

  Maximum Length: 30

  The reference group name.

{
    "type":"object",
    "properties":{
        "ReferenceGroupName":{
            "title":"Reference Group Name",
            "maxLength":"30",
            "type":"string",
            "description":"The reference group name.",
            "nullable":true
        },
        "ModuleId":{
            "title":"Module",
            "maxLength":"32",
            "type":"string",
            "description":"The unique module identifier associated with a logical business area such as billing or payment.",
            "nullable":false
        },
        "PscLookupValue":{
            "title":"Lookup Values",
            "type":"array",
            "description":"The lookup value resource is used to view, create, delete or modify lookup values associated with a lookup type. The object stores lookup value information such as lookup code and meaning.",
            "items":{
                "$ref":"#/components/schemas/publicSectorLookupTypes-PscLookupValue-item-patch-request"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the lookup type code.",
            "nullable":true
        },
        "CustomizationLevel":{
            "title":"Configuration Level",
            "maxLength":"1",
            "type":"string",
            "description":"The configuration level code such as system level or user level.",
            "nullable":false,
            "default":"U"
        },
        "Meaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the lookup type code.",
            "nullable":false
        }
    }
}

Nested Schema : Lookup Values

Type: array

Title: Lookup Values

The lookup value resource is used to view, create, delete or modify lookup values associated with a lookup type. The object stores lookup value information such as lookup code and meaning.

Show Source

• Array of: object publicSectorLookupTypes-PscLookupValue-item-patch-request

{
    "title":"Lookup Values",
    "type":"array",
    "description":"The lookup value resource is used to view, create, delete or modify lookup values associated with a lookup type. The object stores lookup value information such as lookup code and meaning.",
    "items":{
        "$ref":"#/components/schemas/publicSectorLookupTypes-PscLookupValue-item-patch-request"
    }
}

Nested Schema : publicSectorLookupTypes-PscLookupValue-item-patch-request

Type: object

Show Source

• AttributeCategory: string
  Title: Attribute Category

  Maximum Length: 30

  The attribute category code.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of the lookup value code.
• DisplaySequence: integer (int64)
  Title: Display Sequence

  The order in which lookup types are displayed.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: true

  Indicates whether a lookup value is enabled. The default value is true.
• EndDateActive: string (date)
  Title: End Date

  The date on which the lookup value code becomes inactive.
• Meaning: string
  Title: Meaning

  Maximum Length: 80

  The meaning of the lookup value code.
• StartDateActive: string (date)
  Title: Start Date

  The date on which the lookup value code becomes active.
• Tag: string
  Title: Tag

  Maximum Length: 150

  The tag of the lookup value code. Tags on lookup codes enable you to add a label to your lookup codes. A tag can be used to categorize lookups based on facilitating searches or guiding how a lookup should be used.

{
    "type":"object",
    "properties":{
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date on which the lookup value code becomes active.",
            "format":"date",
            "nullable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date on which the lookup value code becomes inactive.",
            "format":"date",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the lookup value code.",
            "nullable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order in which lookup types are displayed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "AttributeCategory":{
            "title":"Attribute Category",
            "maxLength":"30",
            "type":"string",
            "description":"The attribute category code.",
            "nullable":true
        },
        "Tag":{
            "title":"Tag",
            "maxLength":"150",
            "type":"string",
            "description":"The tag of the lookup value code. Tags on lookup codes enable you to add a label to your lookup codes. A tag can be used to categorize lookups based on facilitating searches or guiding how a lookup should be used.",
            "nullable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a lookup value is enabled. The default value is true.",
            "nullable":false,
            "default":true
        },
        "Meaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the lookup value code.",
            "nullable":false
        }
    }
}

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

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the lookup type.
• CreationDate: string (date-time)
  Read Only: true

  The date and time on which the lookup type was created.
• CustomizationLevel: string
  Title: Configuration Level

  Maximum Length: 1

  Default Value: U

  The configuration level code such as system level or user level.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of the lookup type code.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date on which the lookup type was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the lookup type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LookupType: string
  Title: Lookup Type

  Maximum Length: 30

  The lookup type code.
• Meaning: string
  Title: Meaning

  Maximum Length: 80

  The meaning of the lookup type code.
• ModuleId: string
  Title: Module

  Maximum Length: 32

  The unique module identifier associated with a logical business area such as billing or payment.
• PscLookupValue: array Lookup Values
  Title: Lookup Values

  The lookup value resource is used to view, create, delete or modify lookup values associated with a lookup type. The object stores lookup value information such as lookup code and meaning.
• ReferenceGroupName: string
  Title: Reference Group Name

  Maximum Length: 30

  The reference group name.
• UserModuleName: string
  Title: User Module Name

  Read Only: true

  Maximum Length: 512

  The module name displayed to the user.
• ViewApplicationId: integer (int64)
  Title: Application

  Default Value: 10560

  The application ID associated with product like permits.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the lookup type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time on which the lookup type was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the lookup type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ViewApplicationId":{
            "title":"Application",
            "type":"integer",
            "description":"The application ID associated with product like permits.",
            "format":"int64",
            "nullable":false,
            "default":"10560",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the lookup type code.",
            "nullable":true,
            "x-queryable":true
        },
        "LookupType":{
            "title":"Lookup Type",
            "maxLength":"30",
            "type":"string",
            "description":"The lookup type code.",
            "nullable":false,
            "x-queryable":true
        },
        "ReferenceGroupName":{
            "title":"Reference Group Name",
            "maxLength":"30",
            "type":"string",
            "description":"The reference group name.",
            "nullable":true,
            "x-queryable":true
        },
        "ModuleId":{
            "title":"Module",
            "maxLength":"32",
            "type":"string",
            "description":"The unique module identifier associated with a logical business area such as billing or payment.",
            "nullable":false,
            "x-queryable":true
        },
        "PscLookupValue":{
            "title":"Lookup Values",
            "type":"array",
            "description":"The lookup value resource is used to view, create, delete or modify lookup values associated with a lookup type. The object stores lookup value information such as lookup code and meaning.",
            "items":{
                "$ref":"#/components/schemas/publicSectorLookupTypes-PscLookupValue-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CustomizationLevel":{
            "title":"Configuration Level",
            "maxLength":"1",
            "type":"string",
            "description":"The configuration level code such as system level or user level.",
            "nullable":false,
            "default":"U",
            "x-queryable":true
        },
        "UserModuleName":{
            "title":"User Module Name",
            "maxLength":"512",
            "type":"string",
            "description":"The module name displayed to the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Meaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the lookup type code.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date on which the lookup type was last updated.",
            "format":"date-time",
            "nullable":false,
            "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 : Lookup Values

Type: array

Title: Lookup Values

The lookup value resource is used to view, create, delete or modify lookup values associated with a lookup type. The object stores lookup value information such as lookup code and meaning.

Show Source

• Array of: object publicSectorLookupTypes-PscLookupValue-item-response

{
    "title":"Lookup Values",
    "type":"array",
    "description":"The lookup value resource is used to view, create, delete or modify lookup values associated with a lookup type. The object stores lookup value information such as lookup code and meaning.",
    "items":{
        "$ref":"#/components/schemas/publicSectorLookupTypes-PscLookupValue-item-response"
    }
}

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

Nested Schema : publicSectorLookupTypes-PscLookupValue-item-response

Type: object

Show Source

• AttributeCategory: string
  Title: Attribute Category

  Maximum Length: 30

  The attribute category code.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The date and time on which the lookup value was created.
• CreationDate: string (date-time)
  Read Only: true

  The user who created the lookup value.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of the lookup value code.
• DisplaySequence: integer (int64)
  Title: Display Sequence

  The order in which lookup types are displayed.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: true

  Indicates whether a lookup value is enabled. The default value is true.
• EndDateActive: string (date)
  Title: End Date

  The date on which the lookup value code becomes inactive.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date on which the lookup value was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the lookup value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LookupCode: string
  Title: Lookup Code

  Maximum Length: 30

  The lookup value code.
• LookupType: string
  Title: Lookup Type

  Maximum Length: 30

  The lookup type code.
• Meaning: string
  Title: Meaning

  Maximum Length: 80

  The meaning of the lookup value code.
• SetId: integer (int64)
  The unique identifier for a set of lookups.
• StartDateActive: string (date)
  Title: Start Date

  The date on which the lookup value code becomes active.
• Tag: string
  Title: Tag

  Maximum Length: 150

  The tag of the lookup value code. Tags on lookup codes enable you to add a label to your lookup codes. A tag can be used to categorize lookups based on facilitating searches or guiding how a lookup should be used.
• ViewApplicationId: integer (int64)
  Title: Application

  The unique application identifier associated with a product.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the lookup value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The user who created the lookup value.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The date and time on which the lookup value was created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ViewApplicationId":{
            "title":"Application",
            "type":"integer",
            "description":"The unique application identifier associated with a product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the lookup value code.",
            "nullable":true,
            "x-queryable":true
        },
        "LookupType":{
            "title":"Lookup Type",
            "maxLength":"30",
            "type":"string",
            "description":"The lookup type code.",
            "nullable":false,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order in which lookup types are displayed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttributeCategory":{
            "title":"Attribute Category",
            "maxLength":"30",
            "type":"string",
            "description":"The attribute category code.",
            "nullable":true,
            "x-queryable":true
        },
        "LookupCode":{
            "title":"Lookup Code",
            "maxLength":"30",
            "type":"string",
            "description":"The lookup value code.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date on which the lookup value code becomes active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date on which the lookup value code becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Tag":{
            "title":"Tag",
            "maxLength":"150",
            "type":"string",
            "description":"The tag of the lookup value code. Tags on lookup codes enable you to add a label to your lookup codes. A tag can be used to categorize lookups based on facilitating searches or guiding how a lookup should be used.",
            "nullable":true,
            "x-queryable":true
        },
        "SetId":{
            "type":"integer",
            "description":"The unique identifier for a set of lookups.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a lookup value is enabled. The default value is true.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "Meaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the lookup value code.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date on which the lookup value was last updated.",
            "format":"date-time",
            "nullable":false,
            "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"
    }
}

Links

PscLookupValue

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes/{publicSectorLookupTypesUniqID}/child/PscLookupValue

Parameters:

• publicSectorLookupTypesUniqID: $request.path.publicSectorLookupTypesUniqID

The lookup value resource is used to view, create, delete or modify lookup values associated with a lookup type. The object stores lookup value information such as lookup code and meaning.

Back to Top