Jump to

• Request
• Response

Get a reference entity

get

/fscmRestApi/resources/11.13.18.05/publicSectorReferenceEntities/{publicSectorReferenceEntitiesUniqID}

Request

Path Parameters

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

Type: object

Show Source

• Address1: string
  Read Only: true

  Maximum Length: 240

  The address in which a reference entity is located.
• Address2: string
  Read Only: true

  Maximum Length: 240

  The address line 2 in which a reference entity is located.
• AgencyId: integer (int32)
  The agency ID of the reference entity.
• Category: string
  Title: Category

  Read Only: true

  Maximum Length: 30

  The category of a reference entity.
• CategoryMeaning: string
  Read Only: true

  Maximum Length: 255

  The meaning of a category as defined for the lookup type.
• City: string
  Read Only: true

  Maximum Length: 60

  The city in which a reference entity is located.
• Classification: string
  Title: Classification

  Read Only: true

  Maximum Length: 10

  The classification of the reference entity.
• ClosedDate: string (date-time)
  The closed date of a reference entity.
• Country: string
  Read Only: true

  Maximum Length: 3

  The country in which a reference entity is located.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the reference entity type.
• CreatedByUserName: string
  Maximum Length: 30

  The user who last updated the reference entity type.
• CreationDate: string (date-time)
  Read Only: true

  The date when the reference entity type was last updated.
• CreationDateLocation: string (date-time)
  Read Only: true

  The creation date of a location child object.
• CurrentTransFlag: string
  Maximum Length: 3

  Indicates the current transaction for a reference entity.
• Description: string
  Title: Description

  The description of a reference entity.
• DescriptionPlain: string
  Title: Description

  The description in plain text.
• FeatureAttributes: string (byte)
  The GIS feature attributes of a reference entity.
• FeatureGeometry: string (byte)
  The GIS feature geometry of a reference entity.
• LastFeatureEditDate: string (date-time)
  The last update date of the feature of reference entity.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the reference entity type was created.
• LastUpdateDateLocation: string (date-time)
  Read Only: true

  The last update date of the GIS feature of the reference entity of a location.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the reference entity type.
• LastUpdatedByUserName: string
  Maximum Length: 30

  The user who last updated the reference entity type.
• Latitude: number
  Read Only: true

  The lattitude of a reference entity location.
• LayoutVersion: string
  Maximum Length: 30

  The layout version of a reference entity.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Longitude: number
  Read Only: true

  The longitude of a reference entity location.
• MigratedDataFlag: string
  Maximum Length: 3

  The migrated flag of the reference entity, indicating whether the reference entity was migrated.
• MobileFlag: string
  Maximum Length: 1

  The mobile flag of reference entity, indicating if it is application to mobile usage.
• ParentRecordKey: integer (int64)
  Title: Parent

  The parent ID of the reference entity.
• PostalCode: string
  Read Only: true

  Maximum Length: 60

  The postal code in which a reference entity is located.
• ProgramTypeId: string
  Maximum Length: 50

  The program type ID of reference entity.
• RecordId: string
  Title: ID

  Maximum Length: 50

  The record ID of the reference entity.
• RecordKey: integer (int64)
  The unique ID for reference entity.
• RecordName: string
  Maximum Length: 80

  The record name for a reference entity.
• RecordNumber: string
  Maximum Length: 64

  The record number for a reference entity.
• RefEntityLocationId: string
  Read Only: true

  Maximum Length: 50

  The location ID of a reference entity.
• RefEntityLocationKey: integer (int64)
  Read Only: true

  The location of a reference entity.
• ReName: string
  Title: Name

  Maximum Length: 100

  The name of a reference entity.
• ReType: string
  Title: Reference Entity Type

  Read Only: true

  Maximum Length: 100

  The reference entity type for a reference entity.
• ReTypeCode: string
  Title: Reference Entity Type ID

  Read Only: true

  Maximum Length: 40

  The type code of a reference entity.
• ReTypeId: string
  Title: Reference Entity Type ID

  Read Only: true

  Maximum Length: 50

  The type ID of a reference entity.
• RowType: string
  Maximum Length: 30

  The row type of a reference entity.
• State: string
  Read Only: true

  Maximum Length: 60

  The state in which a reference entity is located.
• Status: string
  Title: Status

  Maximum Length: 30

  The status of the reference entity.
• StatusMeaning: string
  Read Only: true

  Maximum Length: 50

  The meaning of a status as defined for the lookup type.
• Subcategory: string
  Title: Subcategory

  Read Only: true

  Maximum Length: 30

  The sub category of a reference entity.
• SubcategoryMeaning: string
  Read Only: true

  Maximum Length: 255

  The meaning of a subcategory as defined for the lookup type.
• SubClassification: string
  Title: Subclassification

  Read Only: true

  Maximum Length: 10

  The sub classification of the reference entity.
• SubmitDate: string (date-time)
  The submit date of a reference entity.

{
    "type":"object",
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The address in which a reference entity is located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The address line 2 in which a reference entity is located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The agency ID of the reference entity.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "Category":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of a reference entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"The meaning of a category as defined for the lookup type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city in which a reference entity is located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":10,
            "type":"string",
            "description":"The classification of the reference entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClosedDate":{
            "type":"string",
            "description":"The closed date of a reference entity.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":3,
            "type":"string",
            "description":"The country in which a reference entity is located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the reference entity type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedByUserName":{
            "maxLength":30,
            "type":"string",
            "description":"The user who last updated the reference entity type.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the reference entity type was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDateLocation":{
            "type":"string",
            "description":"The creation date of a location child object.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentTransFlag":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates the current transaction for a reference entity.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "type":"string",
            "description":"The description of a reference entity.",
            "nullable":true,
            "x-queryable":true
        },
        "DescriptionPlain":{
            "title":"Description",
            "type":"string",
            "description":"The description in plain text.",
            "nullable":true,
            "x-queryable":true
        },
        "FeatureAttributes":{
            "type":"string",
            "description":"The GIS feature attributes of a reference entity.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "FeatureGeometry":{
            "type":"string",
            "description":"The GIS feature geometry of a reference entity.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LastFeatureEditDate":{
            "type":"string",
            "description":"The last update date of the feature of reference entity.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the reference entity type was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDateLocation":{
            "type":"string",
            "description":"The last update date of the GIS feature of the reference entity of a location.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the reference entity type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "maxLength":30,
            "type":"string",
            "description":"The user who last updated the reference entity type.",
            "nullable":true,
            "x-queryable":true
        },
        "Latitude":{
            "type":"number",
            "description":"The lattitude of a reference entity location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LayoutVersion":{
            "maxLength":30,
            "type":"string",
            "description":"The layout version of a reference entity.",
            "nullable":true,
            "x-queryable":true
        },
        "Longitude":{
            "type":"number",
            "description":"The longitude of a reference entity location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MigratedDataFlag":{
            "maxLength":3,
            "type":"string",
            "description":"The migrated flag of the reference entity, indicating whether the reference entity was migrated.",
            "nullable":true,
            "x-queryable":true
        },
        "MobileFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The mobile flag of reference entity, indicating if it is application to mobile usage.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentRecordKey":{
            "title":"Parent",
            "type":"integer",
            "description":"The parent ID of the reference entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code in which a reference entity is located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramTypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The program type ID of reference entity.",
            "nullable":true,
            "x-queryable":true
        },
        "ReName":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of a reference entity.",
            "nullable":true,
            "x-queryable":true
        },
        "ReType":{
            "title":"Reference Entity Type",
            "maxLength":100,
            "type":"string",
            "description":"The reference entity type for a reference entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReTypeCode":{
            "title":"Reference Entity Type ID",
            "maxLength":40,
            "type":"string",
            "description":"The type code of a reference entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReTypeId":{
            "title":"Reference Entity Type ID",
            "maxLength":50,
            "type":"string",
            "description":"The type ID of a reference entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordId":{
            "title":"ID",
            "maxLength":50,
            "type":"string",
            "description":"The record ID of the reference entity.",
            "nullable":false,
            "x-queryable":true
        },
        "RecordKey":{
            "type":"integer",
            "description":"The unique ID for reference entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecordName":{
            "maxLength":80,
            "type":"string",
            "description":"The record name for a reference entity.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordNumber":{
            "maxLength":64,
            "type":"string",
            "description":"The record number for a reference entity.",
            "nullable":false,
            "x-queryable":true
        },
        "RefEntityLocationId":{
            "maxLength":50,
            "type":"string",
            "description":"The location ID of a reference entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RefEntityLocationKey":{
            "type":"integer",
            "description":"The location of a reference entity.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RowType":{
            "maxLength":30,
            "type":"string",
            "description":"The row type of a reference entity.",
            "nullable":false,
            "x-queryable":true
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state in which a reference entity is located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the reference entity.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusMeaning":{
            "maxLength":50,
            "type":"string",
            "description":"The meaning of a status as defined for the lookup type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubClassification":{
            "title":"Subclassification",
            "maxLength":10,
            "type":"string",
            "description":"The sub classification of the reference entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Subcategory":{
            "title":"Subcategory",
            "maxLength":30,
            "type":"string",
            "description":"The sub category of a reference entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubcategoryMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"The meaning of a subcategory as defined for the lookup type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitDate":{
            "type":"string",
            "description":"The submit date of a reference entity.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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