Jump to

• Request
• Response

Create a work order activity type

post

/crmRestApi/resources/11.13.18.05/workOrderActivityTypes

Request

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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: Manual Duration

  Indicates the estimated duration time (in minutes) that it's expected to complete the work for this work order activity type.
• FsActivityTypeCd: string
  Title: Activity Type Code

  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.
• Name(required): string
  Title: Work Order Type

  Maximum Length: 80

  The display value that identifies the work order activity type.
• 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.
• WoActivityTypeCd: string
  Title: Work Order Type Code

  Maximum Length: 30

  The work order activity type code.
• WoActivityTypeNumber: string
  Title: Activity Type Number

  Maximum Length: 30

  The alternate unique identifier of the work order activity type.
• WoIntegrationCd(required): 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.

{
    "required":[
        "Name",
        "WoIntegrationCd"
    ],
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the work order activity type.",
            "nullable":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
            }
        },
        "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"
            }
        },
        "EstimatedDuration":{
            "title":"Manual Duration",
            "type":"integer",
            "description":"Indicates the estimated duration time (in minutes) that it's expected to complete the work for this work order activity type.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "FsActivityTypeCd":{
            "title":"Activity Type Code",
            "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
        },
        "Name":{
            "title":"Work Order Type",
            "maxLength":80,
            "type":"string",
            "description":"The display value that identifies the work order activity type.",
            "nullable":false
        },
        "WoActivityTypeCd":{
            "title":"Work Order Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The work order activity type code.",
            "nullable":true
        },
        "WoActivityTypeNumber":{
            "title":"Activity Type Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the work order activity type.",
            "nullable":false
        },
        "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"
            }
        },
        "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/workOrderActivityTypes-translations-item-post-request"
            }
        }
    }
}

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 workOrderActivityTypes-translations-item-post-request

{
    "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/workOrderActivityTypes-translations-item-post-request"
    }
}

Nested Schema : workOrderActivityTypes-translations-item-post-request

Type: object

Show Source

• 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.
• 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.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        }
    }
}

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 : workOrderActivityTypes-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 of creating the work order activity type.
• 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: Manual Duration

  Indicates the estimated duration time (in minutes) that it's expected to complete the work for this work order activity type.
• FsActivityTypeCd: string
  Title: Activity Type Code

  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 work order activity type.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

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

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

  Maximum Length: 80

  The display value that identifies the work order activity type.
• 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.
• TypeName: string
  Title: Type of Work Order

  Read Only: true

  Maximum Length: 80

  The type of the service work order.
• WoActivityTypeCd: string
  Title: Work Order Type Code

  Maximum Length: 30

  The work order activity type code.
• 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 of creating the work order activity type.",
            "format":"date-time",
            "nullable":false,
            "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":"Manual Duration",
            "type":"integer",
            "description":"Indicates the estimated duration time (in minutes) that it's expected to complete the work for this work order activity type.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "FsActivityTypeCd":{
            "title":"Activity Type Code",
            "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,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Indicates the date and time of last update of the 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 work order activity type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Work Order Type",
            "maxLength":80,
            "type":"string",
            "description":"The display value that identifies the work order activity type.",
            "nullable":false,
            "x-queryable":true
        },
        "TypeName":{
            "title":"Type of Work Order",
            "maxLength":80,
            "type":"string",
            "description":"The type of the service work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "WoIntegrationCd"
                ]
            }
        },
        "WoActivityTypeCd":{
            "title":"Work Order Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The work order activity type code.",
            "nullable":true,
            "x-queryable":true
        },
        "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/workOrderActivityTypes-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 workOrderActivityTypes-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/workOrderActivityTypes-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 : workOrderActivityTypes-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%3BLookupType%3DORA_SVC_WO_INT_CD%2CLookupCode%3DORA_WO_INT_FFS

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/workOrderActivityTypes/{WoActivityTypeNumber}/child/translations

Parameters:

• WoActivityTypeNumber: $request.path.WoActivityTypeNumber

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