Get all work order field service activity types

get

/crmRestApi/resources/11.13.18.05/workOrderFFSActivityTypes

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

    • FFSActivityTypeByNo Finds the work order activity type by the work order activity type number.
      Finder Variables
      • WoActivityTypeNumber; string; The work order activity type number.
    • FFSActivityTypeByTypeId Finds a field service activity type using the type ID.
      Finder Variables
      • FsActivityTypeId; integer; The field service activity type ID.
    • PrimaryKey Finds a work order activity type using the specified primary key.
      Finder Variables
      • WoActivityTypeId; integer; The unique identifier of the work order activity type.
  • 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:
    • CreatedBy; string; The user who created the work order activity type.
    • CreationDate; string; The date and time when the work order activity type was created.
    • DeletedFlag; boolean; Indicates if the activity type has been deleted.
    • Description; string; The description of the work order activity type.
    • DisplaySequence; integer; The ordering sequence number for the work order activity type.
    • EnabledFlag; boolean; Indicates whether the work order activity type is enabled.
    • EstimatedDuration; integer; Indicates the estimated duration time in minutes to complete the work for the work order activity type.
    • FsActivityTypeId; integer; Indicates the activity type identifier which identifies the activity type to use in Oracle Fusion Field Service for this work order activity type.
    • GroupId; integer; The group identifier which identifies the group that the activity type belongs to in Oracle Fusion Field Service.
    • GroupName; string; The translated display value for the group that the activity type belongs to in Field Service.
    • Label; string; Indicates the Field Service activity type code which identifies the activity type to use in Field Service for this work order activity type.
    • LastUpdateDate; string; Indicates the date and time of last update of the translatable work order activity type.
    • LastUpdatedBy; string; The source who last updated the translatable work order activity type.
    • Name; string; The translated display value that identifies the work order activity type.
    • NodeType; string; Indicates in Field Service activity types that the activity type record created is of type item or type group.
    • Status; string; The status of the activity type in Field Service.
    • TypeId; integer; The unique identifier of the Field Service activity type.
    • WoActivityTypeId; integer; The unique identifier of the work order activity type.
    • WoActivityTypeNumber; string; The alternate unique identifier of the work order activity type.
    • WoIntegrationCd; string; Indicates the type of service work order this work order activity type is associated with.
  • 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 : workOrderFFSActivityTypes
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : workOrderFFSActivityTypes-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the work order activity type.
  • Title: Creation Date
    Read Only: true
    The date and time when the work order activity type was created.
  • Title: Deleted
    Read Only: true
    Maximum Length: 1
    Indicates if the activity type has been deleted.
  • Title: Description
    Maximum Length: 240
    The description of the work order activity type.
  • Title: Display Order
    The ordering sequence number for the work order activity type.
  • Title: Enabled
    Maximum Length: 1
    Default Value: false
    Indicates whether the work order activity type is enabled.
  • Title: Estimated Duration
    Indicates the estimated duration time in minutes to complete the work for the work order activity type.
  • Title: Field Service Activity Type ID
    Indicates the activity type identifier which identifies the activity type to use in Oracle Fusion Field Service for this work order activity type.
  • Title: Activity Type
    Read Only: true
    Maximum Length: 255
    The display value that identifies the field service activity type.
  • Title: Group ID
    Read Only: true
    The group identifier which identifies the group that the activity type belongs to in Oracle Fusion Field Service.
  • Title: Group
    Read Only: true
    Maximum Length: 255
    The translated display value for the group that the activity type belongs to in Field Service.
  • Title: Activity Type Label
    Read Only: true
    Maximum Length: 128
    Indicates the Field Service activity type code which identifies the activity type to use in Field Service for this work order activity type.
  • Title: Last Updated Date
    Read Only: true
    Indicates the date and time of last update of the translatable work order activity type.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The source who last updated the translatable work order activity type.
  • Links
  • Title: Activity Type
    Maximum Length: 80
    The translated display value that identifies the work order activity type.
  • Title: Node Type
    Read Only: true
    Maximum Length: 5
    Indicates in Field Service activity types that the activity type record created is of type item or type group.
  • Title: Activity Type Status
    Read Only: true
    Maximum Length: 8
    The status of the activity type in Field Service.
  • Work Order Activity Type Translations
    Title: Work Order Activity Type Translations
    The work order activity type translations resource is used to view, create, update and delete the translatable values for the work order activity type resource.
  • Title: Type ID
    Read Only: true
    The unique identifier of the Field Service activity type.
  • Title: Type of Work Order
    Read Only: true
    Maximum Length: 80
    The translated display value for the name of the activity type in Field Service.
  • Title: Work Order Activity Type ID
    Read Only: true
    The unique identifier of the work order activity type.
  • Title: Activity Type Number
    Maximum Length: 30
    The alternate unique identifier of the work order activity type.
  • Title: Type of Work Order Code
    Maximum Length: 30
    Indicates the type of service work order this work order activity type is associated with.
Nested Schema : Work Order Activity Type Translations
Type: array
Title: Work Order Activity Type Translations
The work order activity type translations resource is used to view, create, update and delete the translatable values for the work order activity type resource.
Show Source
Nested Schema : workOrderFFSActivityTypes-translations-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the translatable work order activity type.
  • Title: Creation Date
    Read Only: true
    The date and time of creating the translatable work order activity type.
  • Title: Description
    Maximum Length: 240
    The description of the translatable work order activity type.
  • Title: Language
    Maximum Length: 4
    The language to which the work order activity type is translated.
  • Title: Language Code
    Read Only: true
    Maximum Length: 4
    The language code in which the work order activity type is translated.
  • Title: Language Name
    Read Only: true
    Maximum Length: 255
    The display language to which the work order activity type is translated.
  • Title: Last Updated Date
    Read Only: true
    Indicates the date and time of last update of the translatable work order activity type.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The source who last updated the translatable work order activity type.
  • Links
  • Title: Activity Type
    Maximum Length: 80
    The translated display value that identifies the work order activity type.
  • Title: Source Language
    Maximum Length: 4
    The source language from which the work order activity type is translated.
  • Title: Language Code
    Read Only: true
    Maximum Length: 4
    The source language code from which the work order activity type is translated.
  • Title: Language Name
    Read Only: true
    Maximum Length: 255
    The source display language from which the work order activity type is translated.
  • Title: Work Order Activity Type ID
    Read Only: true
    The unique identifier of the translated work order activity type. This is a foreign key to the work order activity type table.
Back to Top