Jump to

• Request
• Response

Get a work order field service activity type

get

/crmRestApi/resources/11.13.18.05/workOrderFFSActivityTypes/{FsActivityTypeId}

Request

Path Parameters

• FsActivityTypeId(required): integer(int32)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the work order activity type.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the work order activity type was created.
• DeletedFlag: boolean
  Title: Deleted

  Read Only: true

  Maximum Length: 1

  Indicates if the activity type has been deleted.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of the work order activity type.
• DisplaySequence: integer (int64)
  Title: Display Order

  The ordering sequence number for the work order activity type.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: false

  Indicates whether the work order activity type is enabled.
• EstimatedDuration: integer (int32)
  Title: Estimated Duration

  Indicates the estimated duration time in minutes to complete the work for the work order activity type.
• FsActivityTypeId: integer (int32)
  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.
• FSActivityTypeName: string
  Title: Activity Type

  Read Only: true

  Maximum Length: 255

  The display value that identifies the field service activity type.
• GroupId: integer (int32)
  Title: Group ID

  Read Only: true

  The group identifier which identifies the group that the activity type belongs to in Oracle Fusion Field Service.
• GroupName: string
  Title: Group

  Read Only: true

  Maximum Length: 255

  The translated display value for the group that the activity type belongs to in Field Service.
• Label: string
  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.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Indicates the date and time of last update of the translatable work order activity type.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The source who last updated the translatable work order activity type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Activity Type

  Maximum Length: 80

  The translated display value that identifies the work order activity type.
• NodeType: string
  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.
• Status: string
  Title: Activity Type Status

  Read Only: true

  Maximum Length: 8

  The status of the activity type in Field Service.
• translations: array 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.
• TypeId: integer (int32)
  Title: Type ID

  Read Only: true

  The unique identifier of the Field Service activity type.
• TypeName: string
  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.
• WoActivityTypeId: integer (int64)
  Title: Work Order Activity Type ID

  Read Only: true

  The unique identifier of the work order activity type.
• WoActivityTypeNumber: string
  Title: Activity Type Number

  Maximum Length: 30

  The alternate unique identifier of the work order activity type.
• WoIntegrationCd: string
  Title: Type of Work Order Code

  Maximum Length: 30

  Indicates the type of service work order this work order activity type is associated with.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the work order activity type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the work order activity type was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the activity type has been deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the work order activity type.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Order",
            "type":"integer",
            "description":"The ordering sequence number for the work order activity type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the work order activity type is enabled.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EstimatedDuration":{
            "title":"Estimated Duration",
            "type":"integer",
            "description":"Indicates the estimated duration time in minutes to complete the work for the work order activity type.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "FSActivityTypeName":{
            "title":"Activity Type",
            "maxLength":255,
            "type":"string",
            "description":"The display value that identifies the field service activity type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "TypeId"
                ]
            }
        },
        "FsActivityTypeId":{
            "title":"Field Service Activity Type ID",
            "type":"integer",
            "description":"Indicates the activity type identifier which identifies the activity type to use in Oracle Fusion Field Service for this work order activity type.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "GroupId":{
            "title":"Group ID",
            "type":"integer",
            "description":"The group identifier which identifies the group that the activity type belongs to in Oracle Fusion Field Service.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "GroupName":{
            "title":"Group",
            "maxLength":255,
            "type":"string",
            "description":"The translated display value for the group that the activity type belongs to in Field Service.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "GroupId"
                ]
            },
            "x-queryable":true
        },
        "Label":{
            "title":"Activity Type Label",
            "maxLength":128,
            "type":"string",
            "description":"Indicates the Field Service activity type code which identifies the activity type to use in Field Service for this work order activity type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Indicates the date and time of last update of the translatable work order activity type.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The source who last updated the translatable work order activity type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Activity Type",
            "maxLength":80,
            "type":"string",
            "description":"The translated display value that identifies the work order activity type.",
            "nullable":false,
            "x-queryable":true
        },
        "NodeType":{
            "title":"Node Type",
            "maxLength":5,
            "type":"string",
            "description":"Indicates in Field Service activity types that the activity type record created is of type item or type group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Activity Type Status",
            "maxLength":8,
            "type":"string",
            "description":"The status of the activity type in Field Service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeId":{
            "title":"Type ID",
            "type":"integer",
            "description":"The unique identifier of the Field Service activity type.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "TypeName":{
            "title":"Type of Work Order",
            "maxLength":80,
            "type":"string",
            "description":"The translated display value for the name of the activity type in Field Service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "WoIntegrationCd"
                ]
            }
        },
        "WoActivityTypeId":{
            "title":"Work Order Activity Type ID",
            "type":"integer",
            "description":"The unique identifier of the work order activity type.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WoActivityTypeNumber":{
            "title":"Activity Type Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the work order activity type.",
            "nullable":false,
            "x-queryable":true
        },
        "WoIntegrationCd":{
            "title":"Type of Work Order Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of service work order this work order activity type is associated with.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "translations":{
            "title":"Work Order Activity Type Translations",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/workOrderFFSActivityTypes-translations-item-response"
            }
        }
    }
}

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 : 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

• Array of: object workOrderFFSActivityTypes-translations-item-response

{
    "title":"Work Order Activity Type Translations",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/workOrderFFSActivityTypes-translations-item-response"
    }
}

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."
        }
    }
}

Nested Schema : workOrderFFSActivityTypes-translations-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the translatable work order activity type.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time of creating the translatable work order activity type.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of the translatable work order activity type.
• Language: string
  Title: Language

  Maximum Length: 4

  The language to which the work order activity type is translated.
• LanguageCode: string
  Title: Language Code

  Read Only: true

  Maximum Length: 4

  The language code in which the work order activity type is translated.
• LanguageDisplayName: string
  Title: Language Name

  Read Only: true

  Maximum Length: 255

  The display language to which the work order activity type is translated.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Indicates the date and time of last update of the translatable work order activity type.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The source who last updated the translatable work order activity type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Activity Type

  Maximum Length: 80

  The translated display value that identifies the work order activity type.
• SourceLang: string
  Title: Source Language

  Maximum Length: 4

  The source language from which the work order activity type is translated.
• SourceLangCode: string
  Title: Language Code

  Read Only: true

  Maximum Length: 4

  The source language code from which the work order activity type is translated.
• SourceLangDisplayName: string
  Title: Language Name

  Read Only: true

  Maximum Length: 255

  The source display language from which the work order activity type is translated.
• WoActivityTypeId: integer (int64)
  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.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the translatable work order activity type.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time of creating the translatable work order activity type.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the translatable work order activity type.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "Language":{
            "title":"Language",
            "maxLength":4,
            "type":"string",
            "description":"The language to which the work order activity type is translated.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "LanguageCode":{
            "title":"Language Code",
            "maxLength":4,
            "type":"string",
            "description":"The language code in which the work order activity type is translated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LanguageDisplayName":{
            "title":"Language Name",
            "maxLength":255,
            "type":"string",
            "description":"The display language to which the work order activity type is translated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Indicates the date and time of last update of the translatable work order activity type.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The source who last updated the translatable work order activity type.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Activity Type",
            "maxLength":80,
            "type":"string",
            "description":"The translated display value that identifies the work order activity type.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "SourceLang":{
            "title":"Source Language",
            "maxLength":4,
            "type":"string",
            "description":"The source language from which the work order activity type is translated.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "SourceLangCode":{
            "title":"Language Code",
            "maxLength":4,
            "type":"string",
            "description":"The source language code from which the work order activity type is translated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceLangDisplayName":{
            "title":"Language Name",
            "maxLength":255,
            "type":"string",
            "description":"The source display language from which the work order activity type is translated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WoActivityTypeId":{
            "title":"Work Order Activity Type ID",
            "type":"integer",
            "description":"The unique identifier of the translated work order activity type. This is a foreign key to the work order activity type table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:OA_TRANSLATABLE":"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"
    }
}

Links

WoIntegrationCdLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BBindLookupType%3DORA_SVC_WO_INT_CD

The following properties are defined on the LOV link relation:

• Source Attribute: WoIntegrationCd; Target Attribute: LookupCode
• Display Attribute: Meaning

translations

Operation: /crmRestApi/resources/11.13.18.05/workOrderFFSActivityTypes/{FsActivityTypeId}/child/translations

Parameters:

• FsActivityTypeId: $request.path.FsActivityTypeId

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.

Back to Top