Jump to

• Request
• Response

update agency option record

patch

/fscmRestApi/resources/11.13.18.05/publicSectorAgencyEmailOptions/{publicSectorAgencyEmailOptionsUniqID}

Request

Path Parameters

• publicSectorAgencyEmailOptionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId and EmailId ---for the Agency Email Options resource and used to uniquely identify an instance of Agency Email Options. The client should not generate the hash key value. Instead, the client should query on the Agency Email Options collection resource with a filter on the primary key values in order to navigate to a specific instance of Agency Email Options.
  
  For example: publicSectorAgencyEmailOptions?q=AgencyId=<value1>;EmailId=<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

• DefaultEmailFlag: string
  Title: Agency Default

  Maximum Length: 1

  The default value of the email ID.
• EmailDescr: string
  Title: Description

  Maximum Length: 750

  The description of the email ID.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the email ID is enabled or not.

{
    "type":"object",
    "properties":{
        "DefaultEmailFlag":{
            "title":"Agency Default",
            "maxLength":"1",
            "type":"string",
            "description":"The default value of the email ID.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the email ID is enabled or not.",
            "nullable":false
        },
        "EmailDescr":{
            "title":"Description",
            "maxLength":"750",
            "type":"string",
            "description":"The description of the email ID.",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  The agency identifier of the public sector entity to which this setup applies.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date and time when the setup was created.
• DefaultEmailFlag: string
  Title: Agency Default

  Maximum Length: 1

  The default value of the email ID.
• EmailDescr: string
  Title: Description

  Maximum Length: 750

  The description of the email ID.
• EmailId: string
  Title: Email

  Maximum Length: 300

  The value of the email ID.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the email ID is enabled or not.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the setup was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who updated last.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The time when the login was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The version number of the object.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who updated last.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the setup was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailId":{
            "title":"Email",
            "maxLength":"300",
            "type":"string",
            "description":"The value of the email ID.",
            "nullable":false,
            "x-queryable":true
        },
        "DefaultEmailFlag":{
            "title":"Agency Default",
            "maxLength":"1",
            "type":"string",
            "description":"The default value of the email ID.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the setup.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this setup applies.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of the object.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the email ID is enabled or not.",
            "nullable":false,
            "x-queryable":true
        },
        "EmailDescr":{
            "title":"Description",
            "maxLength":"750",
            "type":"string",
            "description":"The description of the email ID.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the setup was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The time when the login was last updated.",
            "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