Jump to

• Request
• Response

Get a code technician

get

/fscmRestApi/resources/11.13.18.05/publicSectorSearchCodeTechnicians/{publicSectorSearchCodeTechniciansUniqID}

Request

Path Parameters

• publicSectorSearchCodeTechniciansUniqID: integer
  This is the hash key of the attributes which make up the composite key--- PersonId, PersonDetailPersonId, PersonDetailEffectiveStartDate, PersonDetailEffectiveEndDate, EmailAddressId, PhoneId, PersonNameId, PersonNameEffectiveStartDate, PersonNameEffectiveEndDate, PersonTypeId, PeriodOfServiceId, AssignmentId, AssignmentEffectiveStartDate, AssignmentEffectiveEndDate, AssignmentEffectiveSequence, AssignmentEffectiveLatestChange, AssignmentStatusTypeId, LookupType, LookupCode, JobId, JobEffectiveStartDate, JobEffectiveEndDate, OrganizationId, DepartmentEffectiveStartDate, DepartmentEffectiveEndDate, PositionId, PositionEffectiveStartDate, PositionEffectiveEndDate, GradeId, GradeEffectiveStartDate, GradeEffectiveEndDate, SupervisorNamePersonNameId, SupervisorNameEffectiveStartDate, SupervisorNameEffectiveEndDate, LocationLocationId, LocationEffectiveStartDate, LocationEffectiveEndDate, LegalEmployerOrganizationId, LegalEmployerEffectiveStartDate, LegalEmployerEffectiveEndDate, PersonId1, UserId and BusinessUnitId1 ---for the Search Code Technicians resource and used to uniquely identify an instance of Search Code Technicians. The client should not generate the hash key value. Instead, the client should query on the Search Code Technicians collection resource with a filter on the primary key values in order to navigate to a specific instance of Search Code Technicians.
  
  For example: publicSectorSearchCodeTechnicians?q=PersonId=<value1>;PersonDetailPersonId=<value2>;PersonDetailEffectiveStartDate=<value3>;PersonDetailEffectiveEndDate=<value4>;EmailAddressId=<value5>;PhoneId=<value6>;PersonNameId=<value7>;PersonNameEffectiveStartDate=<value8>;PersonNameEffectiveEndDate=<value9>;PersonTypeId=<value10>;PeriodOfServiceId=<value11>;AssignmentId=<value12>;AssignmentEffectiveStartDate=<value13>;AssignmentEffectiveEndDate=<value14>;AssignmentEffectiveSequence=<value15>;AssignmentEffectiveLatestChange=<value16>;AssignmentStatusTypeId=<value17>;LookupType=<value18>;LookupCode=<value19>;JobId=<value20>;JobEffectiveStartDate=<value21>;JobEffectiveEndDate=<value22>;OrganizationId=<value23>;DepartmentEffectiveStartDate=<value24>;DepartmentEffectiveEndDate=<value25>;PositionId=<value26>;PositionEffectiveStartDate=<value27>;PositionEffectiveEndDate=<value28>;GradeId=<value29>;GradeEffectiveStartDate=<value30>;GradeEffectiveEndDate=<value31>;SupervisorNamePersonNameId=<value32>;SupervisorNameEffectiveStartDate=<value33>;SupervisorNameEffectiveEndDate=<value34>;LocationLocationId=<value35>;LocationEffectiveStartDate=<value36>;LocationEffectiveEndDate=<value37>;LegalEmployerOrganizationId=<value38>;LegalEmployerEffectiveStartDate=<value39>;LegalEmployerEffectiveEndDate=<value40>;PersonId1=<value41>;UserId=<value42>;BusinessUnitId1=<value43>

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorSearchCodeTechnicians-item

Type: object

Show Source

• AgencyAddressId(optional): integer(int64)
  Title: Agency Location

  The unique identifier of the address of the agency associated with the code technician.
• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency associated with the code technician.
• AssignmentType(optional): string
  Title: Assignment Type

  Maximum Length: 30

  The assignment type of the code technician.
• BusinessUnitId(optional): integer(int64)
  The unique identifier of the business unit of the code technician.
• BusinessUnitName(optional): string
  Title: Business Unit

  Maximum Length: 240

  The name of the business unit associated with the code technician.
• CaseCount(optional): integer(int32)
  Title: Cases

  The number of cases assigned to the code technician.
• DepartmentId(optional): string
  Title: Agency Department

  Maximum Length: 30

  The unique identifier of the department associated with the code technician.
• DisplayName(optional): string
  Title: Name

  Maximum Length: 240

  The display name of the code technician.
• EmailAddress(optional): string
  Title: Email

  Maximum Length: 240

  The email address of the code technician.
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1

  The switch to indicate that the code technician is active.
• FirstName(optional): string
  Title: First Name

  Maximum Length: 150

  The first name of the code technician.
• HireDate(optional): string(date)
  Title: Start Date

  The date when the code technician was hired.
• IncidentCount(optional): integer(int32)
  Title: Incidents

  The number of incidents assigned to the code technician.
• IsSupervisor(optional): string
  Title: Is Supervisor

  Maximum Length: 1

  The switch to indicate that the code technician is a supervisor.
• JobFuncGrpId(optional): string
  Title: Job Group

  Maximum Length: 50

  The unique identifier of the job group function associated with the code technician.
• JobTitleId(optional): string
  Title: Job Title

  Maximum Length: 50

  The unique identifier of the job title associated with the code technician.
• LastName(optional): string
  Title: Last Name

  Maximum Length: 150

  The last name of the code technician.
• LegalEmployer(optional): string
  Title: Legal Employer

  Maximum Length: 240

  The legal employer of the code technician.
• links(optional): array Items
  Title: Items

  Link Relations
• ListName(optional): string
  Title: Name

  Maximum Length: 240

  The list name of the code technician.
• Manager(optional): string
  Title: Manager

  Maximum Length: 240

  The manager of the code technician.
• MangaerPersonNumber(optional): string
  Title: Person Number

  Maximum Length: 30

  The unique person number of the manager of the code technician.
• PersonId(optional): integer(int64)
  The unique identifier of the code technician.
• PersonNumber(optional): string
  Title: Person Number

  Maximum Length: 30

  The unique identifier of the code technician person.
• PhoneNumber(optional): string
  Title: Phone

  Maximum Length: 60

  The phone number of the code technician.
• SystemPersonType(optional): string
  Title: System Person Type

  Maximum Length: 30

  The person type of the code technician.
• UserGuid(optional): string
  Maximum Length: 64

  The unique identifier of the code technician user.
• UserId(optional): integer(int64)
  The unique identifier of the user associated with the code technician.
• Username(optional): string
  Title: User Name

  Maximum Length: 100

  The name of the user associated with the code technician.
• WorkerPersonType(optional): string
  Title: Worker Person Type

  Maximum Length: 80

  The worker type of the code technician.

{
    "properties":{
        "AgencyAddressId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the address of the agency associated with the code technician.",
            "title":"Agency Location"
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the code technician.",
            "title":"Agency ID"
        },
        "AssignmentType":{
            "maxLength":30,
            "type":"string",
            "description":"The assignment type of the code technician.",
            "title":"Assignment Type"
        },
        "BusinessUnitId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the business unit of the code technician."
        },
        "BusinessUnitName":{
            "maxLength":240,
            "type":"string",
            "description":"The name of the business unit associated with the code technician.",
            "title":"Business Unit"
        },
        "CaseCount":{
            "format":"int32",
            "type":"integer",
            "description":"The number of cases assigned to the code technician.",
            "title":"Cases"
        },
        "DepartmentId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the department associated with the code technician.",
            "title":"Agency Department"
        },
        "DisplayName":{
            "maxLength":240,
            "type":"string",
            "description":"The display name of the code technician.",
            "title":"Name"
        },
        "EmailAddress":{
            "maxLength":240,
            "type":"string",
            "description":"The email address of the code technician.",
            "title":"Email"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The switch to indicate that the code technician is active.",
            "title":"Enabled"
        },
        "FirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The first name of the code technician.",
            "title":"First Name"
        },
        "HireDate":{
            "format":"date",
            "type":"string",
            "description":"The date when the code technician was hired.",
            "title":"Start Date"
        },
        "IncidentCount":{
            "format":"int32",
            "type":"integer",
            "description":"The number of incidents assigned to the code technician.",
            "title":"Incidents"
        },
        "IsSupervisor":{
            "maxLength":1,
            "type":"string",
            "description":"The switch to indicate that the code technician is a supervisor.",
            "title":"Is Supervisor"
        },
        "JobFuncGrpId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the job group function associated with the code technician.",
            "title":"Job Group"
        },
        "JobTitleId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the job title associated with the code technician.",
            "title":"Job Title"
        },
        "LastName":{
            "maxLength":150,
            "type":"string",
            "description":"The last name of the code technician.",
            "title":"Last Name"
        },
        "LegalEmployer":{
            "maxLength":240,
            "type":"string",
            "description":"The legal employer of the code technician.",
            "title":"Legal Employer"
        },
        "ListName":{
            "maxLength":240,
            "type":"string",
            "description":"The list name of the code technician.",
            "title":"Name"
        },
        "Manager":{
            "maxLength":240,
            "type":"string",
            "description":"The manager of the code technician.",
            "title":"Manager"
        },
        "MangaerPersonNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The unique person number of the manager of the code technician.",
            "title":"Person Number"
        },
        "PersonId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the code technician."
        },
        "PersonNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the code technician person.",
            "title":"Person Number"
        },
        "PhoneNumber":{
            "maxLength":60,
            "type":"string",
            "description":"The phone number of the code technician.",
            "title":"Phone"
        },
        "SystemPersonType":{
            "maxLength":30,
            "type":"string",
            "description":"The person type of the code technician.",
            "title":"System Person Type"
        },
        "UserGuid":{
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the code technician user."
        },
        "UserId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the user associated with the code technician."
        },
        "Username":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the user associated with the code technician.",
            "title":"User Name"
        },
        "WorkerPersonType":{
            "maxLength":80,
            "type":"string",
            "description":"The worker type of the code technician.",
            "title":"Worker Person Type"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top