Jump to

• Request
• Response

Get an agency offering

get

/fscmRestApi/resources/11.13.18.05/publicSectorAgencyOptions/{publicSectorAgencyOptionsUniqID}

Request

Path Parameters

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

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  The unique identifier of the agency. Value is mandatory and is defined by the user during a create action. The identifier of the first agency defined must be 1.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the agency offering.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time the agency offering was created.
• DestURL: string
  Read Only: true

  Maximum Length: 254

  A transient value calculated at runtime that fetches the jet path of the offering options page if it exists.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the offering is enabled for the agency. A value of Y means the offering is enabled. Default value is Y.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The user who last updated the agency offering.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The last date and time the agency offering was updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OfferingId: string
  Title: Offering

  Maximum Length: 80

  The unique identifier of a product offering that can be enabled by the agency. Acceptable values are those offerings enabled in Functional Setup Manager. Value is mandatory and is system-maintained.
• OfferingName: string
  Title: Offering

  Read Only: true

  Maximum Length: 150

  The name of the product offering.
• OptOffering: string
  Read Only: true

  A transient value calculated at runtime to identify whether an offering is enabled or disabled in Functional Setup Manager.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The last date and time the agency offering was updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time the agency offering was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the agency offering.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency. Value is mandatory and is defined by the user during a create action.  The identifier of the first agency defined must be 1.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "DestURL":{
            "maxLength":"254",
            "type":"string",
            "description":"A transient value calculated at runtime that fetches the jet path of the offering options page if it exists.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OptOffering":{
            "type":"string",
            "description":"A transient value calculated at runtime to identify whether an offering is enabled or disabled in Functional Setup Manager.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OfferingName":{
            "title":"Offering",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the product offering.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the offering is enabled for the agency.  A value of Y means the offering is enabled.  Default value is Y.",
            "nullable":false,
            "x-queryable":true
        },
        "OfferingId":{
            "title":"Offering",
            "maxLength":"80",
            "type":"string",
            "description":"The unique identifier of a  product offering that can be enabled by the agency.  Acceptable values are those offerings enabled in Functional Setup Manager. Value is mandatory and is system-maintained.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The user who last updated the agency offering.",
            "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 : 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