Get a document category

get

/fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key--- AgencyId and DocumentCategory ---for the Document Categories resource and used to uniquely identify an instance of Document Categories. The client should not generate the hash key value. Instead, the client should query on the Document Categories collection resource with a filter on the primary key values in order to navigate to a specific instance of Document Categories.

    For example: publicSectorDocumentCategories?q=AgencyId=<value1>;DocumentCategory=<value2>
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : publicSectorDocumentCategories-item-response
Type: object
Show Source
  • Maximum Length: 1
    Default Value: false
    Indicates whether an attachment is required referencing the document category when a permit is accepted. The default value is no.
  • Title: Agency ID
    Default Value: 1
    The agency identifier of the public sector entity to which this document category applies.
  • Title: Category
    Maximum Length: 25
    The value that will be displayed for the document category related to an attachment.
  • Maximum Length: 1
    Default Value: false
    Indicates whether an attachment is required referencing the document category when a permit is completed. The default value is no.
  • Title: Creation Date
    Read Only: true
    The date and time when the document category was created.
  • Title: Description
    Maximum Length: 100
    The long description value for the document category related to an attachment.
  • Title: Category ID
    Maximum Length: 30
    The unique identifier for the document category.
  • Document Subcategories
    Title: Document Subcategories
    Use document subcategories resource to view, update, create, and delete document subcategories. A document subcategory is used to specify the subcategory of a document category for an uploaded attachment.
  • Title: Enabled
    Maximum Length: 1
    Indicates whether the document category is enabled or not available for selection in attachments. If true, the document category is enabled and is a valid value that can be selected as a document category. If false, the document category is not a valid value and can't be selected as a document category. The default value is true.
  • Maximum Length: 1
    Default Value: false
    Indicates whether an attachment is required referencing the document category when a final inspection is added. The default value is no.
  • Maximum Length: 1
    Default Value: false
    Indicates whether an attachment is required referencing the document category when a permit is issued is required. The default value is no.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the document category was last modified.
  • Links
  • Maximum Length: 1
    Default Value: false
    Indicates whether an attachment is required referencing the document category when a permit is submitted. The default value is no.
  • The required documents information for document categories.
Nested Schema : Document Subcategories
Type: array
Title: Document Subcategories
Use document subcategories resource to view, update, create, and delete document subcategories. A document subcategory is used to specify the subcategory of a document category for an uploaded attachment.
Show Source
Nested Schema : publicSectorDocumentCategories-DocumentSubcategory-item-response
Type: object
Show Source
  • Maximum Length: 1
    Default Value: false
    Indicates whether an attachment is required referencing the document subcategory when a permit is accepted. The default value is no.
  • Title: Agency ID
    Default Value: 1
    The agency identifier of the public sector entity to which this document subcategory applies.
  • Maximum Length: 1
    Default Value: false
    Indicates whether an attachment is required referencing the document subcategory when a permit is completed. The default value is no.
  • Title: Creation Date
    Read Only: true
    The date and time when the document subcategory was created.
  • Title: Description
    Maximum Length: 100
    The long description value for the document subcategory related to an attachment.
  • Title: Category ID
    Maximum Length: 30
    The unique identifier for the document category.
  • Title: Subcategory ID
    Maximum Length: 30
    The unique identifier for the document subcategory.
  • Title: Enabled
    Maximum Length: 1
    Indicates whether the document subcategory is enabled or not available for selection in attachments. If true, the document subcategory is enabled and is a valid value that can be selected as a document subcategory. If false, the document subcategory is not a valid value and can't be selected as a document subcategory. The default value is true.
  • Maximum Length: 1
    Default Value: false
    Indicates whether an attachment is required referencing the document subcategory when a final inspection is added. The default value is no.
  • Maximum Length: 1
    Default Value: false
    Indicates whether an attachment is required referencing the document subcategory when a permit is issued is required. The default value is no.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the document subcategory was last modified.
  • Links
  • Title: Subcategory
    Maximum Length: 25
    The value that will be displayed for the document subcategory related to an attachment.
  • Maximum Length: 1
    Default Value: false
    Indicates whether an attachment is required referencing the document subcategory when a permit is submitted. The default value is no.
  • The required documents information for document subcategories.
Back to Top