Get all intake global fields records

get

/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields

Request

Query Parameters
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • IntakePUIDAltKey: Finds the intake global fields that match the public unique identifier key criteria.
      Finder Variables:
      • IntakePuid; string; The public unique identifier for a migrated intake global fields record.
    • PrimaryKey: Finds an intake global fields that matches the primary key criteria.
      Finder Variables:
      • IntakeKey; integer; The unique identifier of the intake global fields.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AgencyFlag; boolean; Indicates whether an agency staff member reported the issue.
    • AnonymousFlag; boolean; Indicates if the issue was reported by an anonymous user.
    • AttXrefTransKey; integer; The key from the attachment cross reference.
    • ComplnAddress1; string; The complainant's first line address.
    • ComplnAddress2; string; The complainant's second line address.
    • ComplnAddress3; string; The complainant's third line address.
    • ComplnAddress4; string; The complainant's fourth line address.
    • ComplnCity; string; The complainant's city.
    • ComplnCountry; string; The complainant's country.
    • ComplnCounty; string; The complainant's county.
    • ComplnPostalCode; string; The complainant's postal code.
    • ComplnPostalPlusFourCode; string; The complainant's postal code plus four.
    • ComplnProvince; string; The complainant's province.
    • ComplnState; string; The complainant's state.
    • CompnEmail; string; The complainant's email.
    • CompnFirstName; string; The complainant's first name.
    • CompnLastName; string; The complainant's last name.
    • CompnMiddleName; string; The complainant's middle name.
    • CompnName; string; The complainant's name.
    • CompnNameSuffix; string; The complainant's name suffix.
    • CompnPhoneAreaCode; string; The complainant's phone area code.
    • CompnPhoneCountryCode; string; The complainant's phone country code.
    • CompnPhoneExtension; string; The complainant's phone extension.
    • CompnPhoneNumber; string; The complainant's phone number.
    • CompnTitle; string; The complainant's title.
    • CreatedBy; string; The name of the user who created the row.
    • CreationDate; string; The date and time when the row was created.
    • DisclosureFlag; boolean; Indicates whether the person who reported the incident chose to keep their information private. This indicator is used when agencies do not accept anonymous incidents, but do provide an option to hide private information. A value of Y means that the information is to be kept private.
    • IntakeId; string; A logical ID for the intake transaction.
    • IntakeKey; integer; The key from the intake record.
    • IntakePuid; string; The public unique identifier for a migrated intake record.
    • IntakeSource; string; The transaction type for the transaction that is the source of an incident.
    • IntakeType; string; The type of record, either an incident or a case.
    • IssueDescription; string; The complainant's issue description.
    • IssueSubtypeId; string; The logical issue subtype ID.
    • IssueTypeId; string; The logical issue type ID.
    • LastUpdateDate; string; The date and time when the row was last updated.
    • LastUpdatedBy; string; The name of the user who last updated the row.
    • Latitude; number; The latitude of the property that is associated with the issue.
    • LayoutVersion; string; The layout version.
    • LocationDescr; string; Indicates location description.
    • Longitude; number; The longitude of the property that is associated with the issue.
    • NotifyMeFlag; boolean; Indicates whether the registered user who reported the incident wishes to receive update notifications.
    • OriginatorSource; string; The external source unique service request ID.
    • OriginatorSrId; string; The external source system identifier, such as 311, CRM, or CX.
    • ParcelIdEntered; string; The property parcel ID.
    • Priority; string; The issue priority code. Valid values are CRITICAL P1, HIGH P2, MEDIUM P3, and LOW P4.
    • PropertyAddress1; string; The first line of the address for the complaint.
    • PropertyAddress2; string; The second line of the address for the complaint.
    • PropertyAddress3; string; The third line of the address for the complaint.
    • PropertyAddress4; string; The fourth line of the address for the complaint.
    • PropertyCity; string; The city for the address of the complaint.
    • PropertyCoordinateX; number; The X coordinate of the property that is the subject of the complaint.
    • PropertyCoordinateY; number; The y coordinate of the property that is the subject of the complaint.
    • PropertyCountry; string; The country for the address of the complaint.
    • PropertyCounty; string; The county of the address of the complaint.
    • PropertyPostalCode; string; The postal code for the address of the complaint.
    • PropertyPostalPlusFourCode; string; The postal code plus four for the address of the complaint.
    • PropertyProvince; string; The province for the address of the complaint.
    • PropertyState; string; The state for the address of the complaint.
    • RecordName; string; Indicates customization jedi name.
    • RecordNumber; string; Indicates customization jedi number.
    • ReportedById; string; Indicates the reporter.
    • RowType; string; Structure definition of the user descriptive flexfield.
    • Severity; string; The incident severity code.
    • Srid; integer; The unique service request ID.
    • Status; string; The incident status.
    • SubmitDate; string; The issue submission date.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : publicSectorCeIntakeGlobalFields
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorCeIntakeGlobalFields-item-response
Type: object
Show Source
Nested Schema : Global Customs
Type: array
Title: Global Customs
The case resource is used to view, create, modify, or delete case information.
Show Source
Nested Schema : Global Customs
Type: array
Title: Global Customs
The global custom resource is used to view, create, modify, or delete a child field of record. Note: The standard actions are not available in the records resource. You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/CE_c.
Show Source
Nested Schema : Global Customs
Type: array
Title: Global Customs
The incident resource is used to view, create, modify, or delete incident information.
Show Source
Nested Schema : publicSectorCeIntakeGlobalFields-Case-item-response
Type: object
Show Source
Nested Schema : Global Customs
Type: array
Title: Global Customs
The case code reference resource is used to view, create, modify, or delete case code references.
Show Source
Nested Schema : Shape
Type: object
Read Only: true
Nested Schema : publicSectorCeIntakeGlobalFields-Case-CaseCodeReference-item-response
Type: object
Show Source
Nested Schema : publicSectorCeIntakeGlobalFields-CeGlobalCustom-item-response
Type: object
Show Source
Nested Schema : publicSectorCeIntakeGlobalFields-Incident-item-response
Type: object
Show Source
Nested Schema : Shape
Type: object
Back to Top