Jump to

• Request
• Response

Get a time recording entry

get

/fscmRestApi/resources/11.13.18.05/publicSectorTimeRecordingEntries/{TeEntryKey}

Request

Path Parameters

• TeEntryKey(required): integer(int64)
  The unique identifier for the time recording entry.

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

Type: object

Show Source

• AgencyId: integer
  The identifier for the public sector agency associated with the time recording entry.
• AssessNow: boolean
  Title: Assess Now

  Indicates that the time recording entry will be assessed immediately for any fees. This can only be turned on if the time recording entry is billable.
• BillableFlag: boolean
  Title: Billable

  Maximum Length: 1

  Indicates whether or not the time recording entry is billable.
• BillRate: number
  Title: Bill Rate

  Read Only: true

  The hourly billing rate used for this time entry.
• Comments: string
  Title: Comments

  Maximum Length: 4000

  The comments entered for this time recording entry.
• FeeCalcStatus: string
  Maximum Length: 1

  The status of the last DMN fee calculation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OverrideBillRate: number
  Title: Override Bill Rate

  The hourly billing rate used to override the default billing rate for this time entry.
• ParentKey: integer (int64)
  The unique identifier for the parent transaction, or classification-level transaction associated with the time recording entry. For example, Permit.
• ParentPuid: string
  Maximum Length: 480

  The public unique identifier for the parent transaction.
• PersonId: integer (int64)
  Title: Name

  The unique identifier for the agency staff associated with the time recording entry.
• PersonPuid: string
  The public unique identifier for the agency staff associated with the time recording entry.
• RecordedDate: string (date)
  Title: Date

  The date when the entered time occurred.
• RecordedHours: integer (int32)
  Title: Hours

  The number of hours recorded for this time entry. This can be between 0 and 23 hours.
• RecordedMinutes: integer (int32)
  Title: Minutes

  The number of minutes recorded for this time entry. This can be between 0 and 59 minutes.
• TeEntryKey: integer (int64)
  The unique identifier for the time recording entry.
• TeEntryPuid: string
  Maximum Length: 480

  The public unique identifier for the time recording entry.
• TimeRecordedUpdateDate: string (date-time)
  Read Only: true

  The date and time when the time recording entry was last updated.
• TransactionKey: integer (int64)
  The unique identifier for the child transaction associated with the time recording entry. For example, Inspection.
• TransactionPuid: string
  Maximum Length: 480

  The public unique identifier for the child transaction.
• TransactionSource: string
  Title: Transaction

  Maximum Length: 3

  A code representing the type of child transaction to which the time recording entry is associated. For example, INS for inspection.
• TransactionTypeCode: string
  Title: Time Type Code

  Maximum Length: 30

  The public unique identifier for the time entry type.
• TransactionTypeKey: integer (int64)
  Title: Time Type Code

  The unique identifier for the time entry type associated with the time recording entry.

{
    "type":"object",
    "properties":{
        "TeEntryPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier for the time recording entry.",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionKey":{
            "type":"integer",
            "description":"The unique identifier for the child transaction associated with the time recording entry. For example, Inspection.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the time recording entry.",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionSource":{
            "title":"Transaction",
            "maxLength":"3",
            "type":"string",
            "description":"A code representing the type of child transaction to which the time recording entry is associated. For example, INS for inspection.",
            "nullable":false,
            "x-queryable":true
        },
        "AssessNow":{
            "title":"Assess Now",
            "type":"boolean",
            "description":"Indicates that the time recording entry will be assessed immediately for any fees. This can only be turned on if the time recording entry is billable.",
            "nullable":true,
            "x-queryable":false
        },
        "RecordedMinutes":{
            "title":"Minutes",
            "type":"integer",
            "description":"The number of minutes recorded for this time entry. This can be between 0 and 59 minutes.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"2"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"4000",
            "type":"string",
            "description":"The comments entered for this time recording entry.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier for the child transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "BillableFlag":{
            "title":"Billable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether or not the time recording entry is billable.",
            "nullable":false,
            "x-queryable":true
        },
        "FeeCalcStatus":{
            "maxLength":"1",
            "type":"string",
            "description":"The status of the last DMN fee calculation.",
            "nullable":true,
            "x-queryable":true
        },
        "OverrideBillRate":{
            "title":"Override Bill Rate",
            "type":"number",
            "description":"The hourly billing rate used to override the default billing rate for this time entry.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentKey":{
            "type":"integer",
            "description":"The unique identifier for the parent transaction, or classification-level transaction associated with the time recording entry. For example, Permit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier for the parent transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionTypeKey":{
            "title":"Time Type Code",
            "type":"integer",
            "description":"The unique identifier for the time entry type associated with the time recording entry.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier for the agency staff associated with the time recording entry.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RecordedHours":{
            "title":"Hours",
            "type":"integer",
            "description":"The number of hours recorded for this time entry. This can be between 0 and 23 hours.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"2"
            },
            "x-queryable":true
        },
        "TeEntryKey":{
            "type":"integer",
            "description":"The unique identifier for the time recording entry.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PersonPuid":{
            "type":"string",
            "description":"The public unique identifier for the agency staff associated with the time recording entry.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillRate":{
            "title":"Bill Rate",
            "type":"number",
            "description":"The hourly billing rate used for this time entry.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionTypeCode":{
            "title":"Time Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier for the time entry type.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TimeRecordedUpdateDate":{
            "type":"string",
            "description":"The date and time when the time recording entry was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordedDate":{
            "title":"Date",
            "type":"string",
            "description":"The date when the entered time occurred.",
            "format":"date",
            "nullable":false,
            "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